open_api_spex
▼
Project version
v3.21.2
v3.21.1
v3.21.0
v3.20.1
v3.20.0
v3.19.1
v3.19.0
v3.18.3
v3.18.2
v3.18.1
v3.18.0
v3.17.3
v3.17.2
v3.17.1
v3.17.0
v3.16.4
v3.16.3
v3.16.2
v3.16.1
v3.16.0
v3.15.0
v3.14.0
v3.13.0
v3.12.0
v3.11.0
v3.10.0
v3.9.0
v3.8.0
v3.7.0
v3.6.0
v3.5.2
v3.5.1
v3.5.0
v3.4.0
v3.3.0
v3.2.1
v3.2.0
v3.1.0
v3.0.0
v2.3.1
v2.3.0
v2.2.0
v2.1.1
v2.1.0
v2.0.0
v1.1.4
v1.1.3
v1.1.2
v1.1.1
v1.1.0
v1.0.1
v1.0.0
Pages
Modules
Mix
Tasks
API Reference
Modules
Mix Tasks
Changelog
v3.21.2 - 2024-10-02
v3.21.1 - 2024-09-17
v3.21.0 - 2024-09-12
v3.20.1 - 2024-07-31
v3.20.0 - 2024-07-10
v3.19.1 - 2024-05-17
v3.19.0 - 2024-04-30
v3.18.3 - 2024-03-15
v3.18.2 - 2024-01-26
v3.18.1 - 2023-12-19
v3.18.0 - 2023-08-23
v3.17.3 - 2023-05-30
v3.17.2 - 2023-05-26
v3.17.1 - 2023-05-22
v3.17.0 - 2023-05-18
v3.16.4- 2023-05-17
v3.16.3 - 2023-05-02
v3.16.2 - 2023-04-13
v3.16.1 - 2023-02-07
v3.16.0 - 2022-11-23
v3.15.0 - 2022-11-02
v3.14.0 - 2022-10-23
v3.13.0 - 2022-09-24
v3.12.0 - 2022-07-21
v3.11.0 - 2021-10-29
v3.10.0 - 2021-01-11
v3.9.0 - 2020-09-14
v3.8.0 - 2020-08-22
v3.7.0 - 2020-06-05
v3.6.0 - 2020-02-13
v3.5.2 - 2019-11-15
v3.5.1 - 2019-11-10
v3.5.0 - 2019-10-29
v3.4.0 - 2019-06-14
v3.3.0 - 2019-05-05
v3.2.1 - 2019-03-11
v3.2.0 - 2019-03-10
v3.1.0 - 2018-10-28
v3.0.0 - 2018-10-25
v2.3.1 - 2018-09-09
v2.3.0 - 2018-08-05
v2.2.0 - 2018-07-07
v2.1.1 - 2018-06-12
v2.1.0 - 2018-06-08
v2.0.0 - 2018-06-06
v1.1.4 - 2018-01-21
v1.1.3 - 2017-10-15
v1.1.2 - 2017-10-15
v1.1.1 - 2017-10-15
v1.1.0 - 2017-10-15
v1.0.1 - 2017-10-12
v1.0.0 - 2017-10-02
Contributing
Open an issue
Send a Pull Request
Get Help
Releasing (Maintainers Only)
Roadmap
Version 4
License
Open API Spex
Installation
Generate Spec
Serve the Spec
Generating the Spec
Serve Swagger UI
Importing an existing schema file
Validating and Casting Params
Generate Examples
Validate Examples
Validate Responses
Copyright and License
OpenApiSpex
Summary
Types
cast_opt/0
read_write_scope/0
Functions
add_parameter_content_parser/3
add_schemas/2
body_params/1
build_schema/2
cast/3
cast/4
cast_and_validate/5
cast_value/2
cast_value/4
error!/3
error_message/1
params/1
path_to_string/1
resolve_schema/2
resolve_schema_modules/1
schema/2
schema_from_map/1
title_from_module/1
validate/3
validate/4
validate_compiled_schema/1
validate_compiled_schema/2
OpenApiSpex.Callback
Summary
Types
t/0
OpenApiSpex.Cast
Summary
Types
cast_opt/0
read_write_scope/0
schema_or_reference/0
t/0
Functions
cast/1
cast/4
error/2
ok/1
success/2
OpenApiSpex.Cast.Discriminator
Summary
Types
t/0
Functions
cast/1
OpenApiSpex.Cast.Error
Summary
Types
all_of_error/0
any_of_error/0
args/0
custom_error/0
exclusive_max_error/0
exclusive_min_error/0
invalid_discriminator_value_error/0
invalid_enum_error/0
invalid_format_error/0
invalid_header_error/0
invalid_schema_error/0
invalid_type_error/0
max_items_error/0
max_length_error/0
max_properties_error/0
maximum_error/0
min_items_error/0
min_length_error/0
min_properties_error/0
minimum_error/0
missing_field_error/0
missing_header_error/0
multiple_of_error/0
no_value_for_discriminator_error/0
null_value_error/0
one_of_error/0
reason/0
t/0
unexpected_field_error/0
unique_items_error/0
Functions
message/1
message_with_path/1
new/2
path_to_string/1
OpenApiSpex.Cast.String
Summary
Functions
cast/1
OpenApiSpex.Components
Summary
Types
responses_map/0
schemas_map/0
t/0
OpenApiSpex.Contact
Summary
Types
t/0
OpenApiSpex.Controller
Sections
Supported OpenAPI fields
Example
OpenApiSpex.ControllerSpecs
Sections
Example
parameters
request_body
responses
Summary
Functions
operation/2
operation_spec/3
security/1
tags/1
OpenApiSpex.DeprecatedCast
Summary
Functions
cast/3
validate/3
validate/4
OpenApiSpex.Discriminator
Summary
Types
t/0
Functions
resolve/3
OpenApiSpex.Encoding
Summary
Types
t/0
OpenApiSpex.Example
Summary
Types
t/0
OpenApiSpex.ExportSpec
Summary
Functions
call/3
OpenApiSpex.Extendable
Summary
Types
t/0
Functions
to_map/1
OpenApiSpex.ExternalDocumentation
Summary
Types
t/0
OpenApiSpex.Header
Summary
Types
t/0
OpenApiSpex.Info
Summary
Types
t/0
OpenApiSpex.JsonErrorResponse
Sections
Examples
Summary
Types
t/0
Functions
response/0
schema/0
OpenApiSpex.License
Summary
Types
t/0
OpenApiSpex.Link
Summary
Types
t/0
OpenApiSpex.MediaType
Summary
Types
t/0
OpenApiSpex.OAuthFlow
Summary
Types
t/0
OpenApiSpex.OAuthFlows
Summary
Types
t/0
OpenApiSpex.OpenApi
Summary
Types
t/0
Callbacks
spec/0
Functions
from_map/1
json_encoder/0
to_map/1
to_map/2
yaml_encoder/0
OpenApiSpex.OpenApi.Decode
Summary
Functions
decode/1
OpenApiSpex.Operation
Summary
Types
t/0
Functions
cast/4
from_plug/2
from_route/1
parameter/5
request_body/4
response/4
validate/4
OpenApiSpex.Operation2
Summary
Functions
cast/5
OpenApiSpex.Parameter
Summary
Types
location/0
parameters/0
style/0
t/0
type/0
Functions
media_type/1
put_schema/2
schema/1
OpenApiSpex.PathItem
Summary
Types
route/0
t/0
Functions
from_routes/1
OpenApiSpex.Paths
Summary
Types
path/0
t/0
Functions
from_router/1
from_routes/1
OpenApiSpex.Plug.AppEnvCache
OpenApiSpex.Plug.Cache
Summary
Callbacks
erase/1
get/1
put/2
Functions
adapter/0
refresh/0
OpenApiSpex.Plug.Cast
Sections
Example
OpenApiSpex.Plug.CastAndValidate
Sections
Example
OpenApiSpex.Plug.JsonRenderErrorV2
OpenApiSpex.Plug.NoneCache
OpenApiSpex.Plug.PersistentTermCache
OpenApiSpex.Plug.PutApiSpec
Sections
Options
Example
Summary
Functions
get_and_cache_controller_action/3
get_spec_and_operation_lookup/1
spec_module/1
OpenApiSpex.Plug.RenderSpec
Sections
Example
OpenApiSpex.Plug.SwaggerUI
Sections
Configuring SwaggerUI
Example
Summary
Functions
get_nonce/3
init/1
OpenApiSpex.Plug.SwaggerUIOAuth2Redirect
Summary
Functions
init/1
OpenApiSpex.Plug.Validate
Sections
Example
Example
Summary
Functions
render_error/2
OpenApiSpex.Reference
Summary
Types
t/0
Functions
resolve_parameter/2
resolve_request_body/2
resolve_response/2
resolve_schema/2
OpenApiSpex.RequestBody
Summary
Types
t/0
OpenApiSpex.Response
Summary
Types
t/0
Functions
resolve_response/2
OpenApiSpex.Responses
Summary
Types
t/0
OpenApiSpex.Schema
Sections
Examples
Summary
Types
data_type/0
schemas/0
t/0
Callbacks
schema/0
Functions
cast/3
example/1
example/2
properties/1
validate/3
validate/4
OpenApiSpex.SchemaConsistency
Summary
Functions
warnings/1
OpenApiSpex.SchemaResolver
Summary
Functions
resolve_schema_modules/1
OpenApiSpex.SecurityRequirement
Summary
Types
t/0
OpenApiSpex.SecurityScheme
Summary
Types
t/0
OpenApiSpex.Server
Summary
Types
t/0
Functions
from_endpoint/1
from_endpoint/2
OpenApiSpex.ServerVariable
Summary
Types
t/0
OpenApiSpex.Tag
Summary
Types
t/0
OpenApiSpex.Test.Assertions
Summary
Functions
assert_schema/3
OpenApiSpex.Test.Assertions2
Summary
Functions
assert_schema/3
OpenApiSpex.TestAssertions
Summary
Functions
assert_operation_response/2
assert_raw_schema/3
assert_request_schema/3
assert_response_schema/3
assert_schema/1
assert_schema/4
OpenApiSpex.Xml
Summary
Types
t/0
Exceptions
OpenApiSpex.SchemaException
mix openapi.spec.json
Sections
Examples
Command line options
mix openapi.spec.yaml
Sections
Examples
Command line options
Search documentation of open_api_spex
Settings
View Source
OpenApiSpex.Plug.AppEnvCache
(open_api_spex v3.21.2)
A cache implementation leveraging Application env.
×