Crate hypers_openapi

Re-exports

• pub use hypers_openapi_macro;
• pub use serde_json;

Modules

• components
  Implements OpenAPI Schema Object types which can be used to define field properties, enum values, array or object types.
• content
  Implements content object for request body and response.
• encoding
  Implements encoding object for content.
• example
  Implements OpenAPI Example Object can be used to define examples for Responses and RequestBodys.
• external_docs
  Implements OpenAPI External Docs Object types.
• header
  Implements OpenAPI Header Object types.
• info
  Implements OpenAPI Metadata types.
• oapi
• operation
  Implements OpenAPI Operation Object types.
• parameter
  Implements OpenAPI Parameter Object types.
• path
  Implements OpenAPI Path Object types.
• request_body
  Implements OpenAPI Request Body types.
• response
  Implements OpenApi Responses.
• schema
  Implements OpenAPI Schema Object types which can be used to define field properties, enum values, array or object types.
• security
  Implements OpenAPI Security Schema types.
• server
  Implements OpenAPI Server Object types to configure target servers.
• tag
  Implements OpenAPI Tag Object types.
• xml
  Implements OpenAPI Xml Object types.

Structs

• Array
  Array represents Vec or slice type of items.
• Components
  Implements OpenAPI Components Object which holds supported reusable objects.
• Config
  Object used to alter Swagger UI settings. Config struct provides Swagger UI configuration for settings which could be altered with docker variables.
• Contact
  OpenAPI Contact information of the API.
• Content
  Content holds request body content or response content.
• Discriminator
  OpenAPI Discriminator object which can be optionally used together with OneOf composite object.
• Example
  Implements OpenAPI Example Object.
• ExternalDocs
  Reference of external resource allowing extended documentation.
• Header
  Implements OpenAPI Header Object for response headers.
• Info
  OpenAPI Info object represents metadata of the API.
• License
  OpenAPI License information of the API.
• OauthConfig
  Object used to alter Swagger UI oauth settings.
• Object
  Implements subset of OpenAPI Schema Object which allows adding other Schemas as properties to this Schema.
• OpenApi
  Root object of the OpenAPI document.
• Operation
  Implements OpenAPI Operation Object object.
• Operations
  Collection for save Operations.
• Parameter
  Implements OpenAPI Parameter Object for Operation.
• Parameters
  Collection for OpenAPI Parameter Objects.
• PathItem
  Implements OpenAPI Path Item Object what describes Operations available on a single path.
• Paths
• RapiDoc
  Implements [Handler] for serving RapiDoc.
• ReDoc
  Implements [Handler] for serving ReDoc.
• Ref
  Implements OpenAPI Reference Object that can be used to reference reusable components such as Schemas or Responses.
• RequestBody
  Implements OpenAPI Request Body.
• Response
  Implements OpenAPI Response Object.
• Responses
  Implements OpenAPI Responses Object.
• Scalar
  Implements [Handler] for serving Scalar.
• SecurityRequirement
  OpenAPI [security requirement][security] object.
• Server
  Represents target server object. It can be used to alter server connection for path operations.
• ServerVariable
  Implements [OpenAPI Server Variable][server_variable] used to substitute variables in Server::url. [server_variable]: https://spec.openapis.org/oas/latest.html#server-variable-object
• ServerVariables
• Servers
  Collection for Server objects.
• StatusError
  StatusError contains http error information.
• SwaggerUi
  Implements [Handler] for serving Swagger UI.
• Tag
  Implements OpenAPI Tag Object.
• Url
  Rust type for Swagger UI url configuration object.
• Xml
  Implements OpenAPI Xml Object.

Enums

• Deprecated
  Value used to indicate whether reusable schema, parameter or operation is deprecated.
• KnownFormat
  Known schema format modifier property to provide fine detail of the primitive type.
• OpenApiVersion
  Represents available OpenAPI versions.
• ParameterIn
  In definition of Parameter.
• ParameterStyle
  Defines how Parameter should be serialized.
• PathItemType
  Path item operation type.
• RefOr
  A Ref or some other type T.
• Required
  Value used to indicate whether parameter or property is required.
• Schema
  Is super type for OpenAPI Schema Object. Schema is reusable resource what can be referenced from path operations and other components using Ref.
• SchemaFormat
  Additional format for SchemaType to fine tune the data type used. If the format is not supported by the UI it may default back to SchemaType alone. Format is an open value, so you can use any formats, even not those defined by the OpenAPI Specification.
• SchemaType
  Represents data type of Schema.
• SecurityScheme
  OpenAPI security scheme for path operations.

Traits

• HandlerArg
• HandlerOut
  A trait for endpoint return type register.
• ToArray
  Trait for converting a type to Array.
• ToParameter
• ToRequestBody
• ToResponse
• ToResponses
• ToSchema

Attribute Macros

• openapi

Derive Macros

• ToParameter
• ToResponse
• ToResponses
• ToSchema