git.iko.soy/typeable/swagger2
on v2.0 help sign in
typeable/swagger2/README.md
37 lines 1.6 kB history raw
1# swagger2
3[![Hackage](https://img.shields.io/hackage/v/swagger2.svg)](http://hackage.haskell.org/package/swagger2)
4[![Build Status](https://travis-ci.org/GetShopTV/swagger2.svg?branch=master)](https://travis-ci.org/GetShopTV/swagger2)
5[![Stackage LTS](http://stackage.org/package/swagger2/badge/lts)](http://stackage.org/lts/package/swagger2)
6[![Stackage Nightly](http://stackage.org/package/swagger2/badge/nightly)](http://stackage.org/nightly/package/swagger2)
8Swagger 2.0 data model.
10The original Swagger 2.0 specification is available at http://swagger.io/specification/.
12## Usage
14This library is inteded to be used for decoding and encoding Swagger 2.0 API specifications as well as manipulating them.
16Please refer to [haddock documentation](http://hackage.haskell.org/package/swagger2).
18Some examples can be found in [`examples/` directory](/examples).
20## Trying out
22All generated swagger specifications can be interactively viewed on [Swagger Editor](http://editor.swagger.io/).
24Ready-to-use specification can be served as JSON and interactive API documentation
25can be displayed using [Swagger UI](https://github.com/swagger-api/swagger-ui).
27Many Swagger tools, including server and client code generation for many languages, can be found on
28[Swagger's Tools and Integrations page](http://swagger.io/open-source-integrations/).
30## Contributing
32We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.
34Please report bugs via the [github issue tracker](https://github.com/GetShopTV/swagger2/issues).
36*GetShopTV Team*