git.iko.soy/typeable/openapi3
on fcbe2f0 help sign in
41 lines 1.7 kB history raw
1# OpenApi 3
3[![Hackage](https://img.shields.io/hackage/v/openapi3.svg)](http://hackage.haskell.org/package/openapi3)
4[![Build Status](https://travis-ci.org/biocad/openapi3.svg?branch=master)](https://travis-ci.org/biocad/openapi3)
5[![Stackage LTS](http://stackage.org/package/openapi3/badge/lts)](http://stackage.org/lts/package/opeopenapi3)
6[![Stackage Nightly](http://stackage.org/package/openapi3/badge/nightly)](http://stackage.org/nightly/package/openapi3)
8OpenAPI 3.0 data model.
10The original OpenAPI 3.0 specification is available at http://swagger.io/specification/.
12This package is heavily based on excellent work on Swagger 2.0 at
13https://github.com/GetShopTV/swagger2.
15## Usage
17This library is intended to be used for decoding and encoding OpenApi 3.0.3 specifications as well as manipulating them.
19Please refer to [haddock documentation](http://hackage.haskell.org/package/openapi3).
21Some examples can be found in [`examples/` directory](/examples).
23## Trying out
25All generated swagger specifications can be interactively viewed on [Swagger Editor](http://editor.swagger.io/).
27Ready-to-use specification can be served as JSON and interactive API documentation
28can be displayed using [Swagger UI](https://github.com/swagger-api/swagger-ui).
30Many Swagger tools, including server and client code generation for many languages, can be found on
31[Swagger's Tools and Integrations page](http://swagger.io/open-source-integrations/).
33## Contributing
35We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.
37Please report bugs via the [github issue tracker](https://github.com/biocad/openapi3/issues).
39*GetShopTV Team*
41*Biocad Team*