# PhoenixSwagger [![Build Status](https://travis-ci.org/xerions/phoenix_swagger.svg?branch=master)](https://travis-ci.org/xerions/phoenix_swagger)

`PhoenixSwagger` is the library that provides [swagger](http://swagger.io/) integration
to the [phoenix](http://www.phoenixframework.org/) web framework.

 - Generate a swagger api specification from phoenix router and controllers
 - Serve [swagger-ui](https://swagger.io/swagger-ui/)
 - Validate requests against parameter schemas
 - Validate responses against schemas in tests

# Installation

Follow the [getting started guide](https://hexdocs.pm/phoenix_swagger/getting-started.html) to install and configure `PhoenixSwagger`.

# Guides

See the [full documentation on hexdocs.pm](https://hexdocs.pm/phoenix_swagger) or browse the [docs](./docs) directory.

# Contributing

Issues and pull requests welcome. You'll also find help on the [#phoenix_swagger](https://elixir-lang.slack.com/messages/phoenix_swagger) channel on the [elixir-lang slack](https://elixir-lang.slack.com).

# License

[Mozilla Public License 2.0](./LICENSE)