Merge pull request #24 from haskell-servant/swagger2-2.0

RFC v1.0

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2016, David Johnson
+Copyright (c) 2015-2016, Servant contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -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).
+

example/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015-2016, Servant contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of servant-swagger nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+