-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove example from README, add motivation and usage sections
- Loading branch information
Showing
3 changed files
with
47 additions
and
166 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# servant-swagger | ||
|
||
[![Build Status](https://travis-ci.org/haskell-servant/servant-swagger.svg?branch=master)](https://travis-ci.org/haskell-servant/servant-swagger) | ||
[![Hackage](https://img.shields.io/hackage/v/servant-swagger.svg)](http://hackage.haskell.org/package/servant-swagger) | ||
[![Stackage LTS](http://stackage.org/package/servant-swagger/badge/lts)](http://stackage.org/lts/package/servant-swagger) | ||
[![Stackage Nightly](http://stackage.org/package/servant-swagger/badge/nightly)](http://stackage.org/nightly/package/servant-swagger) | ||
|
||
Swagger 2.0 conforming json for [servant](https://github.com/haskell-servant/servant) APIs. | ||
|
||
![servant-swagger robot](http://s16.postimg.org/rndz1wbyt/servant.png) | ||
|
||
### Motivation | ||
|
||
Swagger™ is a project used to describe and document RESTful APIs. | ||
Unlike Servant it is language-agnostic and thus is quite popular among developers | ||
in different languages. It also exists for a longer time and has more tools to work with. | ||
|
||
This package provides means to generate Swagger specification for a Servant API | ||
and also to partially test whether API conforms with its specification. | ||
|
||
Generated Swagger specification then can be used for many things such as | ||
- displaying interactive documentation using [Swagger UI](http://swagger.io/swagger-ui/); | ||
- generating clients and servers in many languages using [Swagger Codegen](http://swagger.io/swagger-codegen/); | ||
- and [many others](http://swagger.io/open-source-integrations/). | ||
|
||
### Usage | ||
|
||
Please refer to [haddock documentation](http://hackage.haskell.org/package/servant-swagger). | ||
|
||
Some examples can be found in [`example/` directory](/examples). | ||
|
||
### Try it out | ||
|
||
All generated swagger specifications can be interactively viewed on [Swagger Editor](http://editor.swagger.io/). | ||
|
||
Ready-to-use specification can be served as JSON and interactive API documentation | ||
can be displayed using [Swagger UI](https://github.com/swagger-api/swagger-ui). | ||
|
||
Many Swagger tools, including server and client code generation for many languages, can be found on | ||
[Swagger's Tools and Integrations page](http://swagger.io/open-source-integrations/). | ||
|
||
### Contributing | ||
|
||
We are happy to receive bug reports, fixes, documentation enhancements, and other improvements. | ||
|
||
Please report bugs via the [github issue tracker](https://github.com/haskell-servant/servant-swagger/issues). | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters