Rolodex

Rolodex generates documentation for your Phoenix API.

Simply annotate your Phoenix controller action functions with @doc metadata, and Rolodex will turn these descriptions into valid documentation for any platform.

Currently supports:

• OpenAPI 3.0

Disclaimer

Rolodex is currently under active development! The API is a work in progress as we head towards v1.0.

Documentation

See https://hexdocs.pm/rolodex

Installation

Rolodex is available in Hex. Add it to your deps in mix.exs:

def deps do
  [
    {:rolodex, "~> 0.10.0"}
  ]
end