Skip to content

Support for Phoenix 1.3 #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kwojtaszek wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Support for Phoenix 1.3 #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,14 @@ The configuration options can be setup in `config.exs`:
```elixir
config :phoenix_api_docs,
docs_path: "priv/static/docs",
theme: "triple"
theme: "triple",
router: YourApp.Web.Router
```

Config options:
* `docs_path`: Specify the path where the documentation will be generated. If you want to serve the documentation directly from the `phoenix` you can specify `priv/static/docs`.
* `theme`: HTML theme is generated using the [Aglio renderer](https://github.com/danielgtaylor/aglio).
* `router`: Router of your application, in Phoenix 1.3 it will be YourAppName.Web.Router


## Common problems
Expand Down
2 changes: 1 addition & 1 deletion lib/phoenix_api_docs/generator.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ defmodule PhoenixApiDocs.Generator do
def run do
test_conns = PhoenixApiDocs.ConnLogger.conns
app_module = Mix.Project.get.application |> Keyword.get(:mod) |> elem(0)
router_module = Module.concat([app_module, :Router])
router_module = Application.get_env(:phoenix_api_docs, :router, Module.concat([app_module, :Router]))

%{
host: Keyword.get(api_docs_info, :host, "http://localhost"),
Expand Down