phoenix_swagger v0.1.0 API Reference

Modules

Generates swagger.json file based on controller definitions

Generates functions from the PhoenixSwagger DSL into Swagger maps

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

Defines the swagger path DSL for specifying Controller actions. This module should not be imported directly, it will be automatically imported in the scope of a swagger_path macro body

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. The nest function will convert this to a nested map before final conversion to a JSON map

A swagger response definition. The response status (200, 404, etc.) is the key in the containing map

Struct and helpers for swagger schema

Helper functions and macros for implementing swagger DSL