Rolodex generates documentation for your Phoenix API

A behaviour for defining Rolodex config and functions to parse config

Shared logic for parsing parameter fields

Exposes functions and macros for defining reusable headers in route doc annotations or responses

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)

Configuration for a render group, a serialization target for your docs. You can specify one or more render groups via Rolodex.Config to render docs output(s) for your API

Exposes functions and macros for defining reusable request bodies

Exposes functions and macros for defining reusable responses

Parses and collects documentation metadata for a single Phoenix API route

Macros for defining API routes that Rolodex should document. Functions for serializing these routes into fully formed docs metadata

Exposes functions and macros for defining reusable parameter schemas

A behavior to write to arbitrary entities

Prints all available Rolodex tasks