servant-swagger: Generate a Swagger/OpenAPI/OAS 2.0 specification for your servant API.
Swagger is a project used to describe and document RESTful APIs. The core of the project is the OpenAPI Specification (OAS). This library implements v2.0 of the spec. Unlike Servant it is language-agnostic and thus is quite popular among developers in different languages. It has also existed for a longer time and has more helpful tooling.
This package provides means to generate a Swagger/OAS specification for a Servant API and also to partially test whether an 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.
[Skip to Readme]
Downloads
- servant-swagger-1.1.11.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
- AlpMestanogullari, DavidJohnson, GaelDeest, NickolayKudasov, phadej, MatthiasFischmann, maksbotan, hecate, arianvp, janus
For package maintainers and hackage trustees
Candidates
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 (>=1.4.2.0 && <3), aeson-pretty (>=0.8.7 && <0.9), base (>=4.9.1.0 && <5), base-compat (>=0.10.5 && <0.14), bytestring (>=0.10.8.1 && <0.12), hspec, http-media (>=0.7.1.3 && <0.9), insert-ordered-containers (>=0.2.1.0 && <0.3), lens (>=4.17 && <6), QuickCheck, servant (>=0.18.2 && <0.20), singleton-bool (>=0.1.4 && <0.2), swagger2 (>=2.3.0.1 && <3), text (>=1.2.3.0 && <2.1), unordered-containers (>=0.2.9.0 && <0.3) [details] |
Tested with | ghc ==8.6.5 || ==8.8.4 || ==8.10.2 |
License | BSD-3-Clause |
Copyright | (c) 2015-2018, Servant contributors |
Author | Servant Contributors |
Maintainer | haskell-servant-maintainers@googlegroups.com |
Revised | Revision 1 made by maksbotan at 2023-03-13T19:50:02Z |
Category | Web, Servant, Swagger |
Home page | https://github.com/haskell-servant/servant/tree/master/servant-swagger#readme |
Bug tracker | https://github.com/haskell-servant/servant/issues |
Source repo | head: git clone https://github.com/haskell-servant/servant.git |
Uploaded | by maksbotan at 2022-03-22T22:45:17Z |
Distributions | Arch:1.2, LTSHaskell:1.2.1, NixOS:1.2, Stackage:1.2.1 |
Reverse Dependencies | 23 direct, 15 indirect [details] |
Downloads | 30766 total (156 in the last 30 days) |
Rating | 2.5 (votes: 6) [estimated by Bayesian average] |
Your Rating | |
Status | Docs available [build log] Last success reported on 2022-03-22 [all 1 reports] |