API Reference oaskit v#0.3.0

The main API to work with OpenAPI specifications.

Provides macros to define OpenAPI operations directly from controllers.

A behaviour for validation errors handlers.

The default error handler for validation errors.

Implements formats described in https://spec.openapis.org/api/format.json for JSV's format validation. Some of the described formats are already implemented in JSV directly.

HTTP Structured Field parser implementation following RFC 8941.

A plug to associate an OpenAPI specification with a group of routes in a router or a controller.

This plug will match incoming requests to operations defined with the Oaskit.Controller.operation/2 or Oaskit.Controller.use_operation/2 macros and retrieved from a provided OpenAPI Specification module.

Representation of the Callback Object in OpenAPI Specification.

Representation of the Components Object in OpenAPI Specification.

Representation of the Contact Object in OpenAPI Specification.

Representation of the Discriminator Object in OpenAPI Specification.

Representation of the Encoding Object in OpenAPI Specification.

Representation of the Example Object in OpenAPI Specification.

Representation of the External Documentation Object in OpenAPI Specification.

Representation of the Header Object in OpenAPI Specification.

Representation of the Info Object in OpenAPI Specification.

Representation of the License Object in OpenAPI Specification.

Representation of the Link Object in OpenAPI Specification.

Representation of the Media Type Object in OpenAPI Specification.

Representation of the O Auth Flow Object in OpenAPI Specification.

Representation of the O Auth Flows Object in OpenAPI Specification.

Representation of the Open Api Object in OpenAPI Specification.

Representation of the Operation Object in OpenAPI Specification.

Representation of the Parameter Object in OpenAPI Specification.

Representation of the Path Item Object in OpenAPI Specification.

Representation of the Paths Object in OpenAPI Specification.

Representation of the Request Body Object in OpenAPI Specification.

Representation of the Response Object in OpenAPI Specification.

Representation of the Responses Object in OpenAPI Specification.

A wrapper to embed JSON schemas of any supported type (modules, maps, booleans) in an OpenAPI specification.

Representation of the Security Requirement Object in OpenAPI Specification.

Representation of the Security Scheme Object in OpenAPI Specification.

Representation of the Server Object in OpenAPI Specification.

Representation of the Server Variable Object in OpenAPI Specification.

Representation of the Tag Object in OpenAPI Specification.

Representation of the Xml Object in OpenAPI Specification.

Controller for serving OpenAPI specifications in JSON format or Redoc UI.

Provides the valid_response/3 test helper to validate API responses in your ExUnit tests.

Writes an OpenAPI specification in a JSON file.