Expand README on trying out and contributing
This commit is contained in:
parent
0872c3f7fc
commit
1a2c62ba0c
1 changed files with 17 additions and 4 deletions
21
README.md
21
README.md
|
@ -21,6 +21,7 @@
|
||||||
Given the following `servant` API, `servant-swagger` generates the following json.
|
Given the following `servant` API, `servant-swagger` generates the following json.
|
||||||
|
|
||||||
### [Input](example/File.hs)
|
### [Input](example/File.hs)
|
||||||
|
|
||||||
```haskell
|
```haskell
|
||||||
{-# LANGUAGE DataKinds #-}
|
{-# LANGUAGE DataKinds #-}
|
||||||
{-# LANGUAGE DeriveGeneric #-}
|
{-# LANGUAGE DeriveGeneric #-}
|
||||||
|
@ -142,12 +143,24 @@ main = BL8.writeFile "swagger.json" (encode swagDoc)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
## Try it out
|
|
||||||
- All generated swagger docs can be interactively viewed on <a href="http://editor.swagger.io/">Swagger Editor</a>
|
|
||||||
|
|
||||||
## Limitations
|
## Try it out
|
||||||
- Quite a few, TODO: add this
|
|
||||||
|
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/).
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
- Q: How is this project different from the `swagger` package on `hackage` ?
|
- Q: How is this project different from the `swagger` package on `hackage` ?
|
||||||
- A: This package is based on the latest Swagger 2.0 API
|
- A: This package is based on the latest Swagger 2.0 API
|
||||||
|
|
||||||
|
## 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/dmjio/servant-swagger/issues).
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue