API Reference phoenix_swagger v0.8.3

The PhoenixSwagger module provides macros for defining swagger operations and schemas.

This module defines a DSL for defining swagger definitions in a JSON-API conformant format.

Defines the swagger path DSL for specifying Controller actions.

A swagger operation object ties together parameters, responses, etc.

A swagger parameter definition, similar to a Schema, but swagger defines parameter name (and some other options) to be part of the parameter object itself.

The DSL builds paths out of individual operations, so this is a flattened version of a swagger Path.

A swagger response definition.

Swagger UI in a plug.

A plug to automatically validate all requests in a given scope.

Struct and helpers for swagger schema.

Testing helper module that makes it convenient to assert that phoenix controller responses conform to a swagger spec.

The PhoenixSwagger.Validator module provides converter of swagger schema to ex_json_schema structure for further validation.

See documentation for Mix.Tasks.Phx.Swagger.Generate

Generates swagger.json file based on phoenix router and controllers.