Portolan - OpenAPI documentation for Phoenix built from typespecs, docs and routes

A portolan was a medieval nautical chart describing ports and the routes between them. Portolan does the same for your Phoenix API.

Portolan is removing the boilerplate. Uses types, comments, and the definition of the routes to create the documentation your users need for implementing your great service

Portolan builds the OpenAPI document of a Phoenix application from what the code already says:

• the router gives the paths, verbs and actions
• @spec gives the parameters and responses of every action
• @type gives the schemas
• @moduledoc, @doc and @typedoc give the descriptions
• @deprecated marks deprecated operations

There is no extra DSL to learn and nothing to keep in sync. If something needed for the document is missing, such as an action without @spec or a type that cannot be represented in JSON, the build fails with a compiler diagnostic pointing to the exact file and line.

Check it out and let me know if you have suggestions or improvements.