git.iko.soy/typeable/swagger2
on v1.1.1 help sign in
35 lines 1.4 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)
6Swagger 2.0 data model.
8The original Swagger 2.0 specification is available at http://swagger.io/specification/.
10## Usage
12This library is inteded to be used for decoding and encoding Swagger 2.0 API specifications as well as manipulating them.
14Please refer to [haddock documentation](http://hackage.haskell.org/package/swagger2).
16Some examples can be found in [`examples/` directory](/examples).
18## Trying out
20All generated swagger specifications can be interactively viewed on [Swagger Editor](http://editor.swagger.io/).
22Ready-to-use specification can be served as JSON and interactive API documentation
23can be displayed using [Swagger UI](https://github.com/swagger-api/swagger-ui).
25Many Swagger tools, including server and client code generation for many languages, can be found on
26[Swagger's Tools and Integrations page](http://swagger.io/open-source-integrations/).
28## Contributing
30We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.
32Please report bugs via the [github issue tracker](https://github.com/GetShopTV/swagger2/issues).
34*GetShopTV Team*