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