5synopsis: generate API docs for your servant webservice
8 Library for generating API docs from a servant API definition.
10 Runnable example <https://github.com/haskell-servant/servant/blob/master/servant-docs/example/greet.hs here>.
12 <https://github.com/haskell-servant/servant/blob/master/servant-docs/CHANGELOG.md CHANGELOG>
14homepage: http://haskell-servant.readthedocs.org/
15bug-reports: http://github.com/haskell-servant/servant/issues
18author: Servant Contributors
19maintainer: haskell-servant-maintainers@googlegroups.com
20copyright: 2014-2016 Zalora South East Asia Pte Ltd, 2016-2018 Servant Contributors
31 golden/comprehensive.md
35 location: http://github.com/haskell-servant/servant.git
40 , Servant.Docs.Internal
41 , Servant.Docs.Internal.Pretty
43 -- Bundled with GHC: Lower bound to not force re-installs
44 -- text and mtl are bundled starting with GHC-8.4
46 -- note: mtl lower bound is so low because of GHC-7.8
49 , bytestring >= 0.10.8.1 && < 0.11
50 , text >= 1.2.3.0 && < 1.3
52 -- Servant dependencies
56 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
57 -- Here can be exceptions if we really need features from the newer versions.
59 aeson >= 1.4.1.0 && < 1.5
60 , aeson-pretty >= 0.8.5 && < 0.9
61 , base-compat >= 0.10.5 && < 0.11
62 , case-insensitive >= 1.2.0.11 && < 1.3
63 , control-monad-omega >= 0.3.1 && < 0.4
64 , hashable >= 1.2.7.0 && < 1.3
65 , http-media >= 0.7.1.3 && < 0.8
66 , http-types >= 0.12.2 && < 0.13
67 , lens >= 4.17 && < 4.18
68 , string-conversions >= 0.4.0.1 && < 0.5
69 , unordered-containers >= 0.2.9.0 && < 0.3
72 default-language: Haskell2010
73 ghc-options: -Wall -Wno-redundant-constraints
77 hs-source-dirs: example
87 default-language: Haskell2010
90 default-language: Haskell2010
91 type: exitcode-stdio-1.0
93 other-modules: Servant.DocsSpec
97 -- Dependencies inherited from the library. No need to specify bounds.
107 -- Additonal dependencies
109 tasty >= 1.1.0.4 && < 1.2,
110 tasty-golden >= 2.3.2 && < 2.4,
111 tasty-hunit >= 0.10.0.1 && < 0.11,
112 transformers >= 0.5.2.0 && < 0.6
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list