Rolodex v0.5.1 API Reference
Modules
Rolodex generates documentation for your Phoenix API
A behaviour for defining Rolodex config and functions to parse config
Shared logic for parsing parameter fields
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)
Exposes functions and macros for defining reusable request bodies
Exposes functions and macros for defining reusable responses
Collects metadata associated with an API route
Exposes functions and macros for defining reusable parameter schemas
A behavior to write to arbitrary entities
Mix Tasks
Prints all available Rolodex tasks