servant-swagger: Generate Swagger specification for your servant API.

[ bsd3, library, servant, swagger, web ] [ Propose Tags ] [ Report a vulnerability ]

Please see README.md

[Skip to Readme]

Modules

[Index]

Servant
- Servant.Swagger

Downloads

servant-swagger-1.0.1.tar.gz [browse] (Cabal source package)
Package description (revised from the package)

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

AlpMestanogullari, DavidJohnson, GaelDeest, NickolayKudasov, phadej, MatthiasFischmann, maksbotan, hecate, arianvp, janus

For package maintainers and hackage trustees

edit package information

Candidates

1.1.6, 1.1.7, 1.1.7.1, 1.1.8, 1.1.10

Versions [RSS]	0.0.0.0, 0.0.0.1, 0.1, 0.1.1, 0.1.2, 1.0, 1.0.1, 1.0.2, 1.0.3, 1.1, 1.1.1, 1.1.2, 1.1.2.1, 1.1.3, 1.1.3.1, 1.1.4, 1.1.5, 1.1.6, 1.1.7, 1.1.7.1, 1.1.8, 1.1.9, 1.1.10, 1.1.11, 1.2, 1.2.1
Change log	CHANGELOG.md
Dependencies	aeson, base (>=4.8 && <4.9), bytestring, hspec, http-media, lens, QuickCheck, servant, swagger2 (>=2.0.1 && <2.1), text, unordered-containers [details]
License	BSD-3-Clause
Copyright	(c) 2015-2016, Servant contributors
Author	David Johnson, Nickolay Kudasov
Maintainer	[email protected]
Revised	Revision 3 made by phadej at 2016-05-31T12:05:45Z
Category	Web
Home page	https://github.com/haskell-servant/servant-swagger
Bug tracker	https://github.com/haskell-servant/servant-swagger/issues
Source repo	head: git clone https://github.com/haskell-servant/servant-swagger.git
Uploaded	by NickolayKudasov at 2016-02-05T18:45:34Z
Distributions	Arch:1.2.1, LTSHaskell:1.2.1, NixOS:1.2.1
Reverse Dependencies	23 direct, 15 indirect [details]
Downloads	31659 total (85 in the last 30 days)
Rating	2.5 (votes: 6) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs uploaded by user Build status unknown [no reports yet]

Readme for servant-swagger-1.0.1

[back to package description]

servant-swagger

Swagger 2.0 conforming json for servant APIs.

servant-swagger robot

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;
generating clients and servers in many languages using Swagger Codegen;
and many others.

Usage

Please refer to haddock documentation.

Some examples can be found in example/ directory.

Try it out

All generated swagger specifications can be interactively viewed on Swagger Editor.

Ready-to-use specification can be served as JSON and interactive API documentation can be displayed using Swagger UI.

Many Swagger tools, including server and client code generation for many languages, can be found on Swagger's Tools and Integrations page.

Contributing

We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.

Please report bugs via the github issue tracker.