History

Nicolas BACQUEY 7da7f4eb35 Remove unused imports and variables		2022-11-23 15:06:50 +01:00
..
example	bumped cabal-version field (#1498 )	2022-01-04 22:06:23 +01:00
src/Servant	Remove unused imports and variables	2022-11-23 15:06:50 +01:00
test	moving servant-swagger into the main servant repo	2021-11-18 11:56:38 +01:00
CHANGELOG.md	moving servant-swagger into the main servant repo	2021-11-18 11:56:38 +01:00
LICENSE	moving servant-swagger into the main servant repo	2021-11-18 11:56:38 +01:00
README.md	changing servant-swagger info	2021-11-18 11:56:38 +01:00
servant-swagger.cabal	Allow hspec 2.10 (#1609 )	2022-09-07 07:31:58 +02:00
Setup.hs	moving servant-swagger into the main servant repo	2021-11-18 11:56:38 +01:00

README.md

servant-swagger

Swagger 2.0 conforming json for servant APIs.

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.