PhoenixAutoDoc (phoenix_auto_doc v0.1.3)

PhoenixAutoDoc

PhoenixAutoDoc is a library for automatic documentation of routes in the Phoenix framework.

getting-started-with-phoenixautodoc

Getting started with PhoenixAutoDoc

For the library to work, you need to add it as a dependency in the mix.exs file: {:phoenix_auto_doc, "~> 0.1.3"}.

After that, in the file router.ex you need to add the following:

scope "/YOUR_WAY_FOR_DOCUMENTATION" do
  forward("/", AutoDoc, app: YouProjectWeb)
end

That's all, the library is ready to go.

Link to this section Summary

Functions

Callback implementation for Plug.call/2.

Callback implementation for Plug.init/1.

Link to this section Functions

Link to this function

call(conn, opts)

Callback implementation for Plug.call/2.

Callback implementation for Plug.init/1.