git.iko.soy/typeable/servant
on orphan-instances help sign in
typeable/servant/servant-swagger/servant-swagger.cabal
127 lines 4.6 kB history raw
1cabal-version: 2.2
2name: servant-swagger
3version: 1.1.11
4synopsis: Generate a Swagger/OpenAPI/OAS 2.0 specification for your servant API.
5description:
6 Swagger is a project used to describe and document RESTful APIs. The core of the
7 project is the [OpenAPI Specification (OAS)](https://swagger.io/docs/specification/about/).
8 This library implements v2.0 of the spec. Unlike Servant it is language-agnostic and thus is
9 quite popular among developers in different languages. It has also existed for a longer time
10 and has more helpful tooling.
11 .
12 This package provides means to generate a Swagger/OAS specification for a Servant API
13 and also to partially test whether an API conforms with its specification.
14 .
15 Generated Swagger specification then can be used for many things such as
16 .
17 * displaying interactive documentation using [Swagger UI](http://swagger.io/swagger-ui/);
18 .
19 * generating clients and servers in many languages using [Swagger Codegen](http://swagger.io/swagger-codegen/);
20 .
21 * and [many others](http://swagger.io/open-source-integrations/).
22homepage: https://github.com/haskell-servant/servant/servant-swagger
23bug-reports: https://github.com/haskell-servant/servant/issues
24license: BSD-3-Clause
25license-file: LICENSE
26author: Servant Contributors
27maintainer: haskell-servant-maintainers@googlegroups.com
28copyright: (c) 2015-2018, Servant contributors
29category: Web, Servant, Swagger
30build-type: Custom
31tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2
33extra-source-files:
34 README.md
35 , CHANGELOG.md
36 , example/server/*.hs
37 , example/src/*.hs
38 , example/test/*.hs
39 , example/*.cabal
40 , example/swagger.json
41 , example/LICENSE
42extra-doc-files:
43 example/src/*.hs
44 , example/test/*.hs
46source-repository head
47 type: git
48 location: https://github.com/haskell-servant/servant.git
50custom-setup
51 setup-depends:
52 base >=4.9 && <5,
53 Cabal >= 1.24 && < 3.5,
54 cabal-doctest >=1.0.6 && <1.1
56library
57 ghc-options: -Wall
58 exposed-modules:
59 Servant.Swagger
60 Servant.Swagger.Test
61 Servant.Swagger.TypeLevel
63 -- Internal modules
64 Servant.Swagger.Internal
65 Servant.Swagger.Internal.Orphans
66 Servant.Swagger.Internal.Test
67 Servant.Swagger.Internal.TypeLevel
68 Servant.Swagger.Internal.TypeLevel.API
69 Servant.Swagger.Internal.TypeLevel.Every
70 Servant.Swagger.Internal.TypeLevel.TMap
71 hs-source-dirs: src
72 build-depends: aeson >=1.4.2.0 && <3
73 , aeson-pretty >=0.8.7 && <0.9
74 , base >=4.9.1.0 && <5
75 , base-compat >=0.10.5 && <0.12
76 , bytestring >=0.10.8.1 && <0.11
77 , http-media >=0.7.1.3 && <0.9
78 , insert-ordered-containers >=0.2.1.0 && <0.3
79 , lens >=4.17 && <6
80 , servant >=0.18.1 && <0.20
81 , singleton-bool >=0.1.4 && <0.2
82 , swagger2 >=2.3.0.1 && <3
83 , text >=1.2.3.0 && <2.1
84 , unordered-containers >=0.2.9.0 && <0.3
86 , hspec
87 , QuickCheck
88 default-language: Haskell2010
90test-suite doctests
91 ghc-options: -Wall
92 build-depends:
93 base,
94 directory >= 1.0,
95 doctest >= 0.17 && <0.19,
96 servant,
97 QuickCheck,
98 filepath
99 default-language: Haskell2010
100 hs-source-dirs: test
101 main-is: doctests.hs
102 type: exitcode-stdio-1.0
104test-suite spec
105 ghc-options: -Wall
106 type: exitcode-stdio-1.0
107 hs-source-dirs: test
108 main-is: Spec.hs
109 build-tool-depends: hspec-discover:hspec-discover >=2.6.0 && <2.8
110 build-depends: base
111 , base-compat
112 , aeson >=1.4.2.0 && <3
113 , hspec >=2.6.0 && <2.8
114 , QuickCheck
115 , lens
116 , lens-aeson >=1.0.2 && <1.2
117 , servant
118 , servant-swagger
119 , swagger2
120 , text
121 , template-haskell
122 , utf8-string >=1.0.1.1 && <1.1
123 , time
124 , vector
125 other-modules:
126 Servant.SwaggerSpec
127 default-language: Haskell2010