servant-openapi3

Generate a Swagger/OpenAPI/OAS 3.0 specification for your servant API.

Version2.1.0.0
CategoryWeb, Servant, Swagger
LicenceBSD-3-Clause
AuthorDavid Johnson, Nickolay Kudasov, Maxim Koltsov
MaintainerLaurent P. Rene de Cotret
Homepagegithub.com/haskell-servant/servant
Pinned byhackage servant-openapi3 2.1.0.0
Sourcehackage.haskell.org/package/servant-openapi3-2.1.0.0

Modules

10 modules

Servant.OpenApi4This module provides means to generate and manipulate
Servant.OpenApi.Test2Automatic tests for servant API against OpenApi spec.
Servant.OpenApi.TypeLevel3Useful type families for servant APIs.

Internal modules · 7

Description

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.

Depends on

14 packages

QuickCheck-2.19.0.0in this set
aeson-2.3.2.0in this set
aeson-pretty-0.8.11in this set
base-4.23.0.0with GHC
base-compat-0.15.0in this set
bytestring-0.12.2.0with GHC
hspec-2.11.18in this set
http-media-0.8.1.1in this set
lens-5.3.6in this set
openapi3-3.2.5in this set
servant-0.20.3.0in this set
servant-server-0.20.3.0in this set
singleton-bool-0.1.8in this set
text-2.1.4with GHC

Used by in this set · 0

Nothing in this set depends on it.