servant-openapi3: Generate a Swagger/OpenAPI/OAS 3.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 v3.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-openapi3-2.0.1.6.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
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 2.0.0, 2.0.0.1, 2.0.1.0, 2.0.1.1, 2.0.1.2, 2.0.1.3, 2.0.1.4, 2.0.1.5, 2.0.1.6 (info) |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=1.4.2.0 && <1.6 || >=2.0.1.0 && <2.3), aeson-pretty (>=0.8.7 && <0.9), base (>=4.9.1.0 && <4.20), base-compat (>=0.10.5 && <0.14), bytestring (>=0.10.8.1 && <0.13), hspec, http-media (>=0.7.1.3 && <0.9), insert-ordered-containers (>=0.2.1.0 && <0.3), lens (>=4.17 && <5.4), openapi3 (>=3.2.3 && <3.3), QuickCheck, servant (>=0.17 && <0.21), singleton-bool (>=0.1.4 && <0.2), text (>=1.2.3.0 && <3), unordered-containers (>=0.2.9.0 && <0.3) [details] |
| Tested with | ghc ==8.6.5 || ==8.8.4 || ==8.10.7 || ==9.0.2 || ==9.2.7 || ==9.4.5 || ==9.6.2 |
| License | BSD-3-Clause |
| Copyright | (c) 2015-2020, Servant contributors |
| Author | David Johnson, Nickolay Kudasov, Maxim Koltsov |
| Maintainer | nickolay.kudasov@gmail.com, kolmax94@gmail.com |
| Revised | Revision 7 made by maksbotan at 2024-05-23T19:35:13Z |
| Category | Web, Servant, Swagger |
| Home page | https://github.com/biocad/servant-openapi3 |
| Bug tracker | https://github.com/biocad/servant-openapi3/issues |
| Source repo | head: git clone https://github.com/biocad/servant-openapi3.git |
| Uploaded | by maksbotan at 2022-12-20T12:34:04Z |
| Distributions | LTSHaskell:2.0.1.6, NixOS:2.0.1.6, Stackage:2.0.1.6 |
| Reverse Dependencies | 7 direct, 5 indirect [details] |
| Downloads | 7638 total (122 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2022-12-20 [all 1 reports] |
Readme for servant-openapi3-2.0.1.6
[back to package description]servant-openapi3
OpenAPI 3.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.