View Source API Reference swagdox v0.1.0

Modules

Swagdox is a library for extracting Open API specifications from Elixir function docs.

Defines a security scheme for an OpenAPI document.

Configuration for the Swagdox library.

Describes a documented endpoint in an application controller.

An order placed by a customer

Describes a parameter in an OpenAPI specification.

Parses endpoint docstrings to extract Open API specification data.

Represents a path in the Open API specification.

Builds paths from a router by calling the routes function.

Describes a response in an OpenAPI specification.

This module provides a way to extract the fields and types of an Ecto.Schema.

Builds a list of all schemas by inspecting the router to get a list of the controllers.

Defines an authorization option for an endpoint in an OpenAPI specification.

OpenAPI specification.

Describes a type in an OpenAPI specification.

A user of the application

Routes for our SwagdoxWeb application.

Mix Tasks

Generates OpenAPI specification from Elixir function docs.