open_api_spex v3.2.0 API Reference
Modules
Provides the entry-points for defining schemas, validating and casting
Defines the OpenApiSpex.Callback.t
type
Defines the OpenApiSpex.Discriminator.t
type
Defines the OpenApiSpex.Components.t
type
Defines the OpenApiSpex.Contact.t
type
Defines the OpenApiSpex.Discriminator.t
type
Defines the OpenApiSpex.Encoding.t
type
Defines the OpenApiSpex.Example.t
type
Defines the OpenApiSpex.ExternalDocumentation.t
type
Defines the OpenApiSpex.Header.t
type
Defines the OpenApiSpex.Info.t
type
Defines the OpenApiSpex.License.t
type
Defines the OpenApiSpex.Link.t
type
Defines the OpenApiSpex.MediaType.t
type
Defines the OpenApiSpex.OAuthFlow.t
type
Defines the OpenApiSpex.OAuthFlows.t
type
Defines the OpenApiSpex.OpenApi.t
type
Defines the OpenApiSpex.Operation.t
type
Defines the OpenApiSpex.Operation.t
type
Defines the OpenApiSpex.Parameter.t
type
Defines the OpenApiSpex.PathItem.t
type
Defines the OpenApiSpex.Paths.t
type
Module plug that will cast the Conn.params
and Conn.body_params
according to the schemas defined for the operation.
Note that when using this plug, the body params are no longer merged into Conn.params
and must be read from Conn.body_params
separately
Module plug that will cast and validate the Conn.params
and Conn.body_params
according to the schemas defined for the operation
Module plug that calls a given module to obtain the Api Spec and store it as private in the Conn
Renders the API spec as a JSON response
Module plug that serves SwaggerUI
Module plug that validates params against the schema defined for an operation
Defines the OpenApiSpex.Reference.t
type
Defines the OpenApiSpex.RequestBody.t
type
Defines the OpenApiSpex.Response.t
type
Defines teh OpenApiSpex.Responses.t
type
Defines the OpenApiSpex.Schema.t
type and operations for casting and validating against a schema
Internal module used to resolve OpenApiSpex.Schema
structs from atoms
Defines the OpenApiSpex.SecurityRequirement.t
type
Defines the OpenApiSpex.SecurityScheme.t
type
Defines the OpenApiSpex.Server.t
type
Defines the OpenApiSpex.ServerVariable.t
type
Defines the OpenApiSpex.Tag.t
type
Defines helpers for testing API responses and examples against API spec schemas
Defines helpers for testing API responses and examples against API spec schemas
Defines the OpenApiSpex.Xml.t
type