name: servant-openapi3
version: 2.0.1.6
synopsis: Generate a Swagger/OpenAPI/OAS 3.0 specification for your servant API.
description:
Swagger is a project used to describe and document RESTful APIs. The core of the
project is the [OpenAPI Specification (OAS)](https://swagger.io/docs/specification/about/).
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](http://swagger.io/swagger-ui/);
.
* generating clients and servers in many languages using [Swagger Codegen](http://swagger.io/swagger-codegen/);
.
* and [many others](http://swagger.io/open-source-integrations/).
homepage: https://github.com/biocad/servant-openapi3
bug-reports: https://github.com/biocad/servant-openapi3/issues
license: BSD3
license-file: LICENSE
author: David Johnson, Nickolay Kudasov, Maxim Koltsov
maintainer: nickolay.kudasov@gmail.com, kolmax94@gmail.com
copyright: (c) 2015-2020, Servant contributors
category: Web, Servant, Swagger
build-type: Custom
cabal-version: 1.18
tested-with:
GHC ==8.6.5
|| ==8.8.4
|| ==8.10.7
|| ==9.0.2
|| ==9.2.2
|| ==9.4.3
extra-source-files:
README.md
, CHANGELOG.md
, example/server/*.hs
, example/src/*.hs
, example/test/*.hs
, example/*.cabal
, example/swagger.json
, example/LICENSE
extra-doc-files:
example/src/*.hs
, example/test/*.hs
source-repository head
type: git
location: https://github.com/biocad/servant-openapi3.git
custom-setup
setup-depends:
base >=4.9 && <4.18,
Cabal >= 1.24,
cabal-doctest >=1.0.6 && <1.1
library
ghc-options: -Wall
exposed-modules:
Servant.OpenApi
Servant.OpenApi.Test
Servant.OpenApi.TypeLevel
-- Internal modules
Servant.OpenApi.Internal
Servant.OpenApi.Internal.Orphans
Servant.OpenApi.Internal.Test
Servant.OpenApi.Internal.TypeLevel
Servant.OpenApi.Internal.TypeLevel.API
Servant.OpenApi.Internal.TypeLevel.Every
Servant.OpenApi.Internal.TypeLevel.TMap
hs-source-dirs: src
build-depends: aeson >=1.4.2.0 && <1.6 || >=2.0.1.0 && <2.2
, aeson-pretty >=0.8.7 && <0.9
, base >=4.9.1.0 && <4.18
, base-compat >=0.10.5 && <0.13
, bytestring >=0.10.8.1 && <0.12
, http-media >=0.7.1.3 && <0.9
, insert-ordered-containers >=0.2.1.0 && <0.3
, lens >=4.17 && <5.3
, servant >=0.17 && <0.20
, singleton-bool >=0.1.4 && <0.2
, openapi3 >=3.2.3 && <3.3
, text >=1.2.3.0 && <3
, unordered-containers >=0.2.9.0 && <0.3
, hspec
, QuickCheck
default-language: Haskell2010
test-suite doctests
ghc-options: -Wall
build-depends:
base,
directory >= 1.0,
doctest >= 0.11.1 && <0.21,
servant,
QuickCheck,
filepath
default-language: Haskell2010
hs-source-dirs: test
main-is: doctests.hs
type: exitcode-stdio-1.0
test-suite spec
ghc-options: -Wall
type: exitcode-stdio-1.0
hs-source-dirs: test
main-is: Spec.hs
build-tool-depends: hspec-discover:hspec-discover >=2.6.0 && <2.11
build-depends: base
, base-compat
, aeson
, hspec >=2.6.0 && <2.11
, QuickCheck
, lens
, lens-aeson >=1.0.2 && <1.3
, servant
, servant-openapi3
-- openapi3 3.1.0 fixes some ordering-related issues, making tests stable
, openapi3 >= 3.1.0
, text
, template-haskell
, utf8-string >=1.0.1.1 && <1.1
, time
, vector
other-modules:
Servant.OpenApiSpec
default-language: Haskell2010