Rolodex v0.4.1 API Reference

Modules

Rolodex generates documentation for your Phoenix API

Configuration for Rolodex

Defines shared params to be applied to every route within a Phoenix pipeline

Takes a Rolodex.Config.t(), a list of Rolodex.Route.t(), and a map of shared Rolodex.Schema modules. Transforms them into a String.t(), formatted for the destination (e.g. Swagger JSON)

Collects metadata associated with an API route

Exposes functions and macros for working with request and response parameters

A behavior to write to arbitrary entities

Defines writer config params

Mix Tasks

Prints all available Rolodex tasks