https://github.com/xerions/phoenix_swagger

Swagger integration to Phoenix framework
https://github.com/xerions/phoenix_swagger

elixir phoenix swagger

Last synced: 3 months ago
JSON representation

Swagger integration to Phoenix framework

• Host: GitHub
• URL: https://github.com/xerions/phoenix_swagger
• Owner: xerions
• License: mpl-2.0
• Created: 2015-09-04T07:19:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T12:56:51.000Z (3 months ago)
• Last Synced: 2024-10-29T15:23:33.168Z (3 months ago)
• Topics: elixir, phoenix, swagger
• Language: Elixir
• Homepage:
• Size: 4.38 MB
• Stars: 693
• Watchers: 19
• Forks: 182
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Provides swagger integration to the Phoenix framework. (Documentation)
• fucking-awesome-elixir - phoenix_swagger - Provides swagger integration to the Phoenix framework. (Documentation)
• awesome-elixir - phoenix_swagger - Provides swagger integration to the Phoenix framework. (Documentation)

README

        
# PhoenixSwagger

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

[![Module Version](https://img.shields.io/hexpm/v/phoenix_swagger.svg)](https://hex.pm/packages/phoenix_swagger)

[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/phoenix_swagger/)

[![Total Download](https://img.shields.io/hexpm/dt/phoenix_swagger.svg)](https://hex.pm/packages/phoenix_swagger)

[![License](https://img.shields.io/hexpm/l/phoenix_swagger.svg)](https://github.com/xerions/phoenix_swagger/blob/master/LICENSE)

[![Last Updated](https://img.shields.io/github/last-commit/xerions/phoenix_swagger.svg)](https://github.com/xerions/phoenix_swagger/commits/master)

`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 [guides](https://github.com/xerions/phoenix_swagger/tree/master/guides) 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)