servant-openapi3: Generate a Swagger/OpenAPI/OAS 3.0 specification for your servant API.
This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.
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]
Properties
| Versions | 2.0.0, 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 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=1.4.2.0 && <1.6), aeson-pretty (>=0.8.7 && <0.9), base (>=4.9.1.0 && <4.15), base-compat (>=0.10.5 && <0.12), bytestring (>=0.10.8.1 && <0.11), hspec, http-media (>=0.7.1.3 && <0.9), insert-ordered-containers (>=0.2.1.0 && <0.3), lens (>=4.17 && <4.20), openapi3 (>=3.0.0 && <4.0), QuickCheck, servant (>=0.17 && <0.19), singleton-bool (>=0.1.4 && <0.2), text (>=1.2.3.0 && <1.3), unordered-containers (>=0.2.9.0 && <0.3) [details] |
| 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 |
| 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 2020-10-08T09:03:54Z |
Modules
[Index] [Quick Jump]
- Servant
Downloads
- servant-openapi3-2.0.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
Package maintainers
For package maintainers and hackage trustees
Readme for servant-openapi3-2.0.0
[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.