# Blue Bird
[](https://travis-ci.org/rhazdon/blue_bird)
[](https://hex.pm/packages/blue_bird)
[](https://coveralls.io/github/rhazdon/blue_bird?branch=master)
[](https://github.com/rhazdon/blue_bird/blob/master/LICENSE)
[](https://beta.hexfaktor.org/github/rhazdon/blue_bird)
`BlueBird` is a library written in the `Elixir` programming language for the [Phoenix framework](http://www.phoenixframework.org/).
It lets you generate API documentation in the [API Blueprint](https://apiblueprint.org/) format from annotations in controllers and automated tests.
## Installation
1. Add BlueBird to your mix.exs dependencies (directly from Github until released):
``` elixir
defp deps do
[{:blue_bird, "~> 0.1.3"}]
end
```
2. Run `mix deps.get` to fetch the dependencies:
```
$ mix deps.get
```
3. In your `test/test_helper.exs` start the BlueBird logger via `BlueBird.start()` and configure the results formatter as follows:
``` elixir
BlueBird.start()
ExUnit.start(formatters: [ExUnit.CLIFormatter, BlueBird.Formatter])
```
4. Configure BlueBird by adding to `config.exs`:
``` elixir
config :blue_bird,
docs_path: "priv/static/docs",
theme: "triple",
router: YourApp.Web.Router
```
5. Add `blue_bird_info` to your `mix.exs` to improve the generated docs:
``` elixir
def blue_bird_info do
[
host: "https://api.acme.com",
title: "ACME API",
description: "API requires authorization. All requests must have valid `auth_token`"
]
end
```
6. Add `BlueBird.Controller` to your `web.ex` controller function:
``` elixir
def controller do
quote do
...
use BlueBird.Controller
...
end
```
7. Install aglio:
```bash
$ npm install aglio -g
```
## Usage
#### Controller
* Use `api\3` macro to generate the specification for the controller action:
```elixir
defmodule App.CommentController do
use App.Web, :controller
api :GET, "/posts/:post_id/comments" do
group "Comment" # If not provided, it will be guessed from the controller name (resource name)
title "List comments for specific docs"
description "Optional description that will be displayed in the documentation"
note "Optional note that will be displayed in the documentation"
parameter :post_id, :integer, :required, "Post ID or slug"
end
def index(conn, %{"post_id" => post_id}) do
...
end
api :PUT, "/posts/:post_id/comments" do
title "Update comment"
parameter :post_id, :integer, :required, "Post ID or slug"
end
def update(conn, %{"comment" => comment_params}) do
...
end
end
```
**API specification options**:
* `method`: HTTP method - GET, POST, PUT, PATCH, DELETE
* `url`: URL route from `phoenix router`
* `group`: Documentation routes are grouped by a group name (defaults to resource name guessed from the controller name)
* `title`: Title (can use Blueprint format)
* `description`: Description (optional, can use Blueprint format)
* `note`: Note (optional, can use Blueprint format)
* `parameter`: `name, type, required/optional, description`
* required - `parameter :post_id, :integer, :required, "Post ID"`
* optional - `parameter :post_id, :integer, "Post ID"`
#### Router
Currently, BlueBird expects that the routes are piped through `:api`.
``` elixir
defmodule TestRouter do
use Phoenix.Router
import Plug.Conn
import Phoenix.Controller
pipeline :api do
...
end
pipeline :foo do
...
end
scope "/" do
pipe_through :api
get "/get", TestController, :get # This will work
end
scope "/" do
pipe_through [:api, :foo]
get "/get", TestController, :get # This will work
end
scope "/" do
pipe_through :foo
get "/get", TestController, :get # This will not work
end
end
```
#### Tests
* In your tests select which requests and responses you want to include in the documentation by saving `conn` to `BlueBird.ConnLogger`:
``` elixir
test "list comments for post", %{conn: conn} do
insert_posts_with_comments()
conn = conn
|> get(comments_path(conn, :index)
|> BlueBird.ConnLogger.save()
assert json_response(conn, 200)
end
```
After you run your tests, documentation in the API Blueprint format will be saved to `api.apib`
```
$ mix test
```
To generate the documentation in a HTML format use the convenience wrapper tothe [Aglio renderer](https://github.com/danielgtaylor/aglio)
```
$ mix bird.gen.docs
```
## Configuration
### `config.exs`:
The configuration options can be setup in `config.exs`:
```elixir
config :blue_bird,
docs_path: "priv/static/docs",
theme: "triple",
router: YourApp.Web.Router
```
**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
### `blue_bird_info()`:
**Options**:
* `host`: API host.
* `title`: Documentation title (can use Blueprint format).
* `description`: Documentation description (can use Blueprint format).
## FAQ
##### Route is not generated after adding API annotations to the controller
Please make sure that the route you are using in the annotation matches the route from the `phoenix router` (including params) exactly. Run `mix phoenix.routes` (or `mix phx.routes` if Phoenix >= 1.3) and compare the routes.
##### Body Parameter are not rendered
BlueBird reads the `body_params` from `%Plug.Conn{}`. These map is only set if `body_params` is a binary.
Example:
``` elixir
post build_conn(), "/", Poison.encode! %{my: data} # recommended
post build_conn(), "/", "my=data"
```
## TODO:
- [ ] `raise error` when route that is used in the annotation is not available in the `phoenix router`
- [ ] Document that routes have to be part of the api pipeline for now
- [ ] Make the pipelines configurable
- [ ] Document `BlueBird.Controller`
- [ ] Document `BlueBird.BlueprintWriter`
- [x] Document `Mix.Tasks.Bird.Gen.Docs`
