0777fd3...master · typeable/servant-swagger-ui

git.iko.soy/typeable/servant-swagger-ui

118 files changed+62591−29791

since splitsnapshots

unifiedsplit

.gitignore+3−1

@@ -1,6 +1,8 @@

11dist/

2+dist-newstyle/

3+.ghc.environment.*

24.stack-work/

35.cabal-sandbox

46cabal.sandbox.config

57src/highlight.js

6−src/style.css

8+src/style.css

.stylish-haskell.yaml+5−66

@@ -1,77 +1,16 @@

1−# stylish-haskell configuration file

2−# ==================================

3−

4−# The stylish-haskell tool is mainly configured by specifying steps. These steps

5−# are a list, so they have an order, and one specific step may appear more than

6−# once (if needed). Each file is processed by these steps in the given order.

71steps:

8− # Convert some ASCII sequences to their Unicode equivalents. This is disabled

9− # by default.

10− # - unicode_syntax:

11− # # In order to make this work, we also need to insert the UnicodeSyntax

12− # # language pragma. If this flag is set to true, we insert it when it's

13− # # not already present. You may want to disable it if you configure

14− # # language extensions using some other method than pragmas. Default:

15− # # true.

16− # add_language_pragma: true

17−

18− # Import cleanup

192 - imports:

20− # There are different ways we can align names and lists.

21− #

22− # - global: Align the import names and import list throughout the entire

23− # file.

24− #

25− # - file: Like global, but don't add padding when there are no qualified

26− # imports in the file.

27− #

28− # - group: Only align the imports per group (a group is formed by adjacent

29− # import lines).

30− #

31− # - none: Do not perform any alignment.

32− #

33− # Default: global.

343 align: group

35−

36− # Language pragmas

4+ list_align: after_alias

5+ long_list_align: new_line

6+ empty_list_align: right_after

7+ list_padding: module_name

378 - language_pragmas:

38− # We can generate different styles of language pragma lists.

39− #

40− # - vertical: Vertical-spaced language pragmas, one per line.

41− #

42− # - compact: A more compact style.

43− #

44− # - compact_line: Similar to compact, but wrap each line with

45− # `{-#LANGUAGE #-}'.

46− #

47− # Default: vertical.

489 style: vertical

49−

50− # stylish-haskell can detect redundancy of some language pragmas. If this

51− # is set to true, it will remove those redundant pragmas. Default: true.

5210 remove_redundant: true

53−

54− # Align the types in record declarations

55− - records: {}

56−

57− # Replace tabs by spaces. This is disabled by default.

58− # - tabs:

59− # # Number of spaces to use for each tab. Default: 8, as specified by the

60− # # Haskell report.

61− # spaces: 8

62−

63− # Remove trailing whitespace

6411 - trailing_whitespace: {}

65−

66−# A common setting is the number of columns (parts of) code will be wrapped

67−# to. Different steps take this into account. Default: 80.

6812columns: 80

69−

70−# Sometimes, language extensions are specified in a cabal file or from the

71−# command line instead of using language pragmas in the file. stylish-haskell

72−# needs to be aware of these, so it can parse the file correctly.

73−#

74−# No language extensions are enabled by default.

7513language_extensions:

7614 - MultiParamTypeClasses

7715 - FlexibleContexts

16+ - ExplicitForAll

.travis.meta.ymldeleted−11

@@ -1,11 +0,0 @@

1−language: haskell-multi-ghc

2−

3−env:

4− - GHCVER=7.10.3 CABALVER=1.22 PEDANTIC=YES

5−

6−matrix:

7− fast_finish: true

8−

9−branches:

10− only:

11− - master

.travis.yml+194−60

@@ -1,65 +1,199 @@

1−# This file has been generated by travis-meta-yaml 0.2.0.0

2−# see https://github.com/phadej/travis-meta-yaml

3−sudo: false

1+# This Travis job script has been generated by a script via

2+#

3+# haskell-ci '--output' '.travis.yml' '--config=cabal.haskell-ci' 'cabal.project'

4+#

5+# To regenerate the script (for example after adjusting tested-with) run

6+#

7+# haskell-ci regenerate

8+#

9+# For more information, see https://github.com/haskell-CI/haskell-ci

10+#

11+# version: 0.10.3

12+#

13+version: ~> 1.0

414language: c

5−before_install:

6−- unset CC

7−- export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH

8−- echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo

9− '?')]"

10−- cabal --version

11−- ghc --version

12−- if [ "$NOTESTS" = "YES" ]; then export CABALCONFOPTS=""; export CABALTEST="true";

13− else export CABALCONFOPTS="--enable-tests --enable-benchmarks"; export CABALTEST="cabal

14− test"; fi

15−- if [ "$PEDANTIC" = "YES" ]; then export CABALBUILDOPTS="--ghc-options=-Werror --ghc-options=-Wall";

16− fi

17−install:

18−- if [ -f $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz ]; then zcat $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz

19− > $HOME/.cabal/packages/hackage.haskell.org/00-index.tar; ls -l $HOME/.cabal/packages/hackage.haskell.org/;

20− fi; cabal update; sed -i 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config; if [ -n "$CABALCONFIG"

21− ]; then cp $CABALCONFIG cabal.config; fi; if [ -n "$STACKAGESNAPSHOT" ]; then curl

22− --silent https://www.stackage.org/$STACKAGESNAPSHOT/cabal.config | grep -v "$(cabal

23− info . -v0 | head -n 1 | awk '{ print $2 }' | sed -E 's/-[0-9]+(\.[0-9]+)+//') =="

24− > cabal.config; fi; cabal install --only-dependencies $CABALCONFOPTS --dry -v >

25− installplan.txt; sed -i -e '1,/^Resolving /d' installplan.txt; cat installplan.txt;

26− if diff -u $HOME/.cabsnap/installplan.txt installplan.txt; then echo "cabal build-cache

27− HIT"; rm -rfv .ghc; cp -av $HOME/.cabsnap/ghc $HOME/.ghc; cp -av $HOME/.cabsnap/lib

28− $HOME/.cabsnap/share $HOME/.cabsnap/bin $HOME/.cabal/; else echo "cabal build-cache

29− MISS"; rm -rf $HOME/.cabsnap; mkdir -p $HOME/.ghc $HOME/.cabal/lib $HOME/.cabal/share

30− $HOME/.cabal/bin; cabal install --only-dependencies $CABALCONFOPTS; fi; if [ ! -d

31− $HOME/.cabsnap ]; then echo "snapshotting package-db to build-cache"; mkdir $HOME/.cabsnap;

32− cp -av $HOME/.ghc $HOME/.cabsnap/ghc; cp -av $HOME/.cabal/lib $HOME/.cabal/share

33− $HOME/.cabal/bin installplan.txt $HOME/.cabsnap/; fi;

34−script:

35−- if [ -f configure.ac ]; then autoreconf -i; fi

36−- cabal configure $CABALCONFOPTS -v2

37−- cabal build $CABALBUILDOPTS

38−- $CABALTEST

39−- if [ "$CABALVER" = "1.22" ]; then cabal check; fi

40−- cabal sdist

41−- SRC_TGZ=$(cabal info . | awk '{print $2;exit}').tar.gz && (cd dist && cabal install

42− --force-reinstalls "$SRC_TGZ")

43−matrix:

44− fast_finish: true

45− include:

46− - env: GHCVER=7.10.3 CABALVER=1.22 PEDANTIC=YES

47− addons:

48− apt:

49− sources:

50− - hvr-ghc

51− packages:

52− - cabal-install-1.22

53− - ghc-7.10.3

54− - libgmp-dev

55− compiler: ! ': # ghc-7.10.3 cabal-1.22'

15+os: linux

16+dist: xenial

17+git:

18+ # whether to recursively clone submodules

19+ submodules: false

5620branches:

5721 only:

58− - master

59−before_cache:

60−- rm -fv $HOME/.cabal/packages/hackage.haskell.org/build-reports.log

61−- rm -fv $HOME/.cabal/packages/hackage.haskell.org/00-index.tar

22+ - master

6223cache:

6324 directories:

64− - $HOME/.cabsnap

65− - $HOME/.cabal/packages

25+ - $HOME/.cabal/packages

26+ - $HOME/.cabal/store

27+ - $HOME/.hlint

28+before_cache:

29+ - rm -fv $CABALHOME/packages/hackage.haskell.org/build-reports.log

30+ # remove files that are regenerated by 'cabal update'

31+ - rm -fv $CABALHOME/packages/hackage.haskell.org/00-index.*

32+ - rm -fv $CABALHOME/packages/hackage.haskell.org/*.json

33+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.cache

34+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar

35+ - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar.idx

36+ - rm -rfv $CABALHOME/packages/head.hackage

37+jobs:

38+ include:

39+ - compiler: ghc-8.10.2

40+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.10.2","cabal-install-3.2"]}}

41+ os: linux

42+ - compiler: ghc-8.8.4

43+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.8.4","cabal-install-3.2"]}}

44+ os: linux

45+ - compiler: ghc-8.6.5

46+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.6.5","cabal-install-3.2"]}}

47+ os: linux

48+ - compiler: ghc-8.4.4

49+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.4.4","cabal-install-3.2"]}}

50+ os: linux

51+ - compiler: ghc-8.2.2

52+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.2.2","cabal-install-3.2"]}}

53+ os: linux

54+ - compiler: ghc-8.0.2

55+ addons: {"apt":{"sources":[{"sourceline":"deb http://ppa.launchpad.net/hvr/ghc/ubuntu xenial main","key_url":"https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x063dab2bdc0b3f9fcebc378bff3aeacef6f88286"}],"packages":["ghc-8.0.2","cabal-install-3.2"]}}

56+ os: linux

57+before_install:

58+ - HC=$(echo "/opt/$CC/bin/ghc" | sed 's/-/\//')

59+ - WITHCOMPILER="-w $HC"

60+ - HADDOCK=$(echo "/opt/$CC/bin/haddock" | sed 's/-/\//')

61+ - HCPKG="$HC-pkg"

62+ - unset CC

63+ - CABAL=/opt/ghc/bin/cabal

64+ - CABALHOME=$HOME/.cabal

65+ - export PATH="$CABALHOME/bin:$PATH"

66+ - TOP=$(pwd)

67+ - "HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\\d+)\\.(\\d+)\\.(\\d+)(\\.(\\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')"

68+ - echo $HCNUMVER

69+ - CABAL="$CABAL -vnormal+nowrap"

70+ - set -o pipefail

71+ - TEST=--enable-tests

72+ - BENCH=--enable-benchmarks

73+ - HEADHACKAGE=false

74+ - rm -f $CABALHOME/config

75+ - |

76+ echo "verbose: normal +nowrap +markoutput" >> $CABALHOME/config

77+ echo "remote-build-reporting: anonymous" >> $CABALHOME/config

78+ echo "write-ghc-environment-files: always" >> $CABALHOME/config

79+ echo "remote-repo-cache: $CABALHOME/packages" >> $CABALHOME/config

80+ echo "logs-dir: $CABALHOME/logs" >> $CABALHOME/config

81+ echo "world-file: $CABALHOME/world" >> $CABALHOME/config

82+ echo "extra-prog-path: $CABALHOME/bin" >> $CABALHOME/config

83+ echo "symlink-bindir: $CABALHOME/bin" >> $CABALHOME/config

84+ echo "installdir: $CABALHOME/bin" >> $CABALHOME/config

85+ echo "build-summary: $CABALHOME/logs/build.log" >> $CABALHOME/config

86+ echo "store-dir: $CABALHOME/store" >> $CABALHOME/config

87+ echo "install-dirs user" >> $CABALHOME/config

88+ echo " prefix: $CABALHOME" >> $CABALHOME/config

89+ echo "repository hackage.haskell.org" >> $CABALHOME/config

90+ echo " url: http://hackage.haskell.org/" >> $CABALHOME/config

91+install:

92+ - ${CABAL} --version

93+ - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"

94+ - |

95+ echo "program-default-options" >> $CABALHOME/config

96+ echo " ghc-options: $GHCJOBS +RTS -M6G -RTS" >> $CABALHOME/config

97+ - cat $CABALHOME/config

98+ - rm -fv cabal.project cabal.project.local cabal.project.freeze

99+ - travis_retry ${CABAL} v2-update -v

100+ # Generate cabal.project

101+ - rm -rf cabal.project cabal.project.local cabal.project.freeze

102+ - touch cabal.project

103+ - |

104+ echo "packages: servant-swagger-ui" >> cabal.project

105+ echo "packages: servant-swagger-ui-core" >> cabal.project

106+ echo "packages: servant-swagger-ui-example" >> cabal.project

107+ echo "packages: servant-swagger-ui-jensoleg" >> cabal.project

108+ echo "packages: servant-swagger-ui-redoc" >> cabal.project

109+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui' >> cabal.project ; fi

110+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

111+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-core' >> cabal.project ; fi

112+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

113+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-example' >> cabal.project ; fi

114+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

115+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-jensoleg' >> cabal.project ; fi

116+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

117+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-redoc' >> cabal.project ; fi

118+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

119+ - |

120+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(servant-swagger-ui|servant-swagger-ui-core|servant-swagger-ui-example|servant-swagger-ui-jensoleg|servant-swagger-ui-redoc)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"

121+ - cat cabal.project || true

122+ - cat cabal.project.local || true

123+ - if [ -f "servant-swagger-ui/configure.ac" ]; then (cd "servant-swagger-ui" && autoreconf -i); fi

124+ - if [ -f "servant-swagger-ui-core/configure.ac" ]; then (cd "servant-swagger-ui-core" && autoreconf -i); fi

125+ - if [ -f "servant-swagger-ui-example/configure.ac" ]; then (cd "servant-swagger-ui-example" && autoreconf -i); fi

126+ - if [ -f "servant-swagger-ui-jensoleg/configure.ac" ]; then (cd "servant-swagger-ui-jensoleg" && autoreconf -i); fi

127+ - if [ -f "servant-swagger-ui-redoc/configure.ac" ]; then (cd "servant-swagger-ui-redoc" && autoreconf -i); fi

128+ - ${CABAL} v2-freeze $WITHCOMPILER ${TEST} ${BENCH}

129+ - "cat cabal.project.freeze | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"

130+ - rm cabal.project.freeze

131+ - travis_wait 40 ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} --dep -j2 all

132+ - travis_wait 40 ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --dep -j2 all

133+script:

134+ - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)

135+ # Packaging...

136+ - ${CABAL} v2-sdist all

137+ # Unpacking...

138+ - mv dist-newstyle/sdist/*.tar.gz ${DISTDIR}/

139+ - cd ${DISTDIR} || false

140+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec tar -xvf '{}' \;

141+ - find . -maxdepth 1 -type f -name '*.tar.gz' -exec rm '{}' \;

142+ - PKGDIR_servant_swagger_ui="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-[0-9.]*')"

143+ - PKGDIR_servant_swagger_ui_core="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-core-[0-9.]*')"

144+ - PKGDIR_servant_swagger_ui_example="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-example-[0-9.]*')"

145+ - PKGDIR_servant_swagger_ui_jensoleg="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-jensoleg-[0-9.]*')"

146+ - PKGDIR_servant_swagger_ui_redoc="$(find . -maxdepth 1 -type d -regex '.*/servant-swagger-ui-redoc-[0-9.]*')"

147+ # Generate cabal.project

148+ - rm -rf cabal.project cabal.project.local cabal.project.freeze

149+ - touch cabal.project

150+ - |

151+ echo "packages: ${PKGDIR_servant_swagger_ui}" >> cabal.project

152+ echo "packages: ${PKGDIR_servant_swagger_ui_core}" >> cabal.project

153+ echo "packages: ${PKGDIR_servant_swagger_ui_example}" >> cabal.project

154+ echo "packages: ${PKGDIR_servant_swagger_ui_jensoleg}" >> cabal.project

155+ echo "packages: ${PKGDIR_servant_swagger_ui_redoc}" >> cabal.project

156+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui' >> cabal.project ; fi

157+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

158+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-core' >> cabal.project ; fi

159+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

160+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-example' >> cabal.project ; fi

161+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

162+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-jensoleg' >> cabal.project ; fi

163+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

164+ - if [ $HCNUMVER -ge 80200 ] ; then echo 'package servant-swagger-ui-redoc' >> cabal.project ; fi

165+ - "if [ $HCNUMVER -ge 80200 ] ; then echo ' ghc-options: -Werror=missing-methods' >> cabal.project ; fi"

166+ - |

167+ - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(servant-swagger-ui|servant-swagger-ui-core|servant-swagger-ui-example|servant-swagger-ui-jensoleg|servant-swagger-ui-redoc)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"

168+ - cat cabal.project || true

169+ - cat cabal.project.local || true

170+ # Building...

171+ # this builds all libraries and executables (without tests/benchmarks)

172+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all

173+ # Building with tests and benchmarks...

174+ # build & run tests, build benchmarks

175+ - ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} all

176+ # cabal check...

177+ - (cd ${PKGDIR_servant_swagger_ui} && ${CABAL} -vnormal check)

178+ - (cd ${PKGDIR_servant_swagger_ui_core} && ${CABAL} -vnormal check)

179+ - (cd ${PKGDIR_servant_swagger_ui_example} && ${CABAL} -vnormal check)

180+ - (cd ${PKGDIR_servant_swagger_ui_jensoleg} && ${CABAL} -vnormal check)

181+ - (cd ${PKGDIR_servant_swagger_ui_redoc} && ${CABAL} -vnormal check)

182+ # haddock...

183+ - ${CABAL} v2-haddock $WITHCOMPILER --with-haddock $HADDOCK ${TEST} ${BENCH} all

184+ # Building without installed constraints for packages in global-db...

185+ - rm -f cabal.project.local

186+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all

187+ # Constraint sets

188+ - rm -rf cabal.project.local

189+ # Constraint set servant-0.14

190+ - if [ $HCNUMVER -lt 80800 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='servant ==0.14.*' all ; fi

191+ # Constraint set servant-0.15

192+ - if [ $HCNUMVER -lt 80800 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='servant ==0.15.*' all ; fi

193+ # Constraint set servant-0.16

194+ - if [ $HCNUMVER -lt 81000 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='servant ==0.16.*' all ; fi

195+ # Constraint set servant-0.17

196+ - if [ $HCNUMVER -lt 81000 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='servant ==0.17.*' all ; fi

197+

198+# REGENDATA ("0.10.3",["--output",".travis.yml","--config=cabal.haskell-ci","cabal.project"])

199+# EOF

README.md+16−2

@@ -1,6 +1,8 @@

11# servant-swagger-ui

3−> Servant support for yaml

3+*Provide a Swagger UI for your Servant API*

5+"[Swagger UI](http://swagger.io/swagger-ui/) allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place."

57[![Build Status](https://travis-ci.org/phadej/servant-swagger-ui.svg?branch=master)](https://travis-ci.org/phadej/servant-swagger-ui)

68[![Hackage](https://img.shields.io/hackage/v/servant-swagger-ui.svg)](http://hackage.haskell.org/package/servant-swagger-ui)

@@ -9,4 +11,16 @@

911

1012## Example

1113

12−Check [`example/Main.hs`](https://github.com/phadej/servant-swagger-ui/blob/master/example/Main.hs) for an example.

14+![example screenshot](https://raw.githubusercontent.com/haskell-servant/servant-swagger-ui/master/screenshot.png)

15+

16+Check [`servant-swagger-ui-example/src/Main.hs`](https://github.com/haskell-servant/servant-swagger-ui/blob/master/servant-swagger-ui-example/src/Main.hs) for an example.

17+

18+## Development

19+

20+### Updating of bundled swagger-ui version:

21+

22+- Extract `dist` directory of `swagger-ui` into `swagger-dist-<version>`. Remove the `*.map` files.

23+- update `extra-source-files` in the `.cabal`

24+- move `index.html` into `index.html.tmpl`, do the diff, port the changes

25+- search replace the embbeded directory (in `Servant/Swagger/UI.hs`)

26+- test it works

cabal.haskell-cinew file+17

@@ -0,0 +1,17 @@

1+branches: master

3+constraint-set servant-0.14

4+ ghc: >= 7.8 && <8.8

5+ constraints: servant ==0.14.*

7+constraint-set servant-0.15

8+ ghc: >= 8.0 && <8.8

9+ constraints: servant ==0.15.*

10+

11+constraint-set servant-0.16

12+ ghc: >= 8.0 && <8.10

13+ constraints: servant ==0.16.*

14+

15+constraint-set servant-0.17

16+ ghc: >= 8.0 && <8.10

17+ constraints: servant ==0.17.*

cabal.projectnew file+6

@@ -0,0 +1,6 @@

1+packages:

2+ servant-swagger-ui/

3+ servant-swagger-ui-core/

4+ servant-swagger-ui-example/

5+ servant-swagger-ui-jensoleg/

6+ servant-swagger-ui-redoc/

example/Main.hsdeleted−101

@@ -1,101 +0,0 @@

1−{-# LANGUAGE DataKinds #-}

2−{-# LANGUAGE DeriveGeneric #-}

3−{-# LANGUAGE FlexibleInstances #-}

4−{-# LANGUAGE GeneralizedNewtypeDeriving #-}

5−{-# LANGUAGE MultiParamTypeClasses #-}

6−{-# LANGUAGE OverloadedStrings #-}

7−{-# LANGUAGE ScopedTypeVariables #-}

8−{-# LANGUAGE TemplateHaskell #-}

9−{-# LANGUAGE TypeFamilies #-}

10−{-# LANGUAGE TypeOperators #-}

11−{-# LANGUAGE UndecidableInstances #-}

12−{-# OPTIONS_GHC -fno-warn-orphans #-}

13−module Main (main, catIsMale, catName) where

14−

15−import Control.Lens hiding ((.=))

16−import Data.Aeson (ToJSON (..), object, (.=))

17−import Data.Maybe (fromMaybe)

18−import Data.String (IsString (..))

19−import Data.Text (Text)

20−import GHC.Generics (Generic)

21−import Network.Wai (Application)

22−import System.Environment (getArgs, lookupEnv)

23−import Text.Read (readMaybe)

24−

25−import Data.Swagger

26−import Servant

27−import Servant.Swagger

28−import Servant.Swagger.UI

29−

30−import qualified Network.Wai.Handler.Warp as Warp

31−

32−--

33−

34−data Cat = Cat { catName :: CatName, catIsMale :: Bool }

35− deriving (Generic, Show)

36−

37−instance ToJSON Cat where

38− toJSON (Cat n g) = object [ "catName" .= n , "catIsMale" .= g]

39−

40−newtype CatName = CatName Text

41− deriving (Eq, Show, Generic, FromText)

42−

43−instance ToJSON CatName where

44− toJSON (CatName n) = toJSON n

45−

46−instance IsString CatName where

47− fromString = CatName . fromString

48−

49−instance ToParamSchema CatName

50−instance ToSchema Cat

51−instance ToSchema CatName

52−

53−---

54−

55−type BasicAPI = Get '[PlainText, JSON] Text

56− :<|> "cat" :> Capture ":name" CatName :> Get '[JSON] Cat

57−

58−type SwaggerSchemaEndpoint = "swagger.js" :> Get '[JSON] Swagger

59−

60−data API

61−type API' = BasicAPI

62− :<|> SwaggerSchemaEndpoint

63− :<|> SwaggerUI "ui" SwaggerSchemaEndpoint API

64−

65−instance HasServer API where

66− type ServerT API m = ServerT API' m

67− route _ = route (Proxy :: Proxy API')

68−

69−type instance IsElem' e API = IsElem e API'

70−

71−-- Implementation

72−server :: Server API

73−server =

74− (pure "Hello World" :<|> catEndpoint)

75− :<|> pure swaggerDoc

76− :<|> swaggerUIServer

77− where

78− catEndpoint n = pure $ Cat n False

79−

80−-- Boilerplate

81−

82−swaggerDoc :: Swagger

83−swaggerDoc = toSwagger (Proxy :: Proxy BasicAPI)

84− & info.title .~ "Cats API"

85− & info.version .~ "2016.2.6"

86− & info.description ?~ "This is an API that tests servant-swagger support "

87−

88−api :: Proxy API

89−api = Proxy

90−

91−app :: Application

92−app = serve api server

93−

94−main :: IO ()

95−main = do

96− args <- getArgs

97− case args of

98− ("run":_) -> do

99− p <- fromMaybe 8000 . (>>= readMaybe) <$> lookupEnv "PORT"

100− Warp.run p app

101− _ -> putStrLn "To run, pass 'run' argument"

hackage-docs.shdeleted−78

@@ -1,78 +0,0 @@

1−#!/bin/bash

2−set -e

3−

4−# This if stack-enabled fork of https://github.com/ekmett/lens/blob/master/scripts/hackage-docs.sh

5−

6−if [ "$#" -ne 1 ]; then

7− echo "Usage: scripts/hackage-docs.sh HACKAGE_USER"

8− exit 1

9−fi

10−

11−user=$1

12−

13−cabal_file=$(find . -maxdepth 1 -name "*.cabal" -print -quit)

14−if [ ! -f "$cabal_file" ]; then

15− echo "Run this script in the top-level package directory"

16− exit 1

17−fi

18−

19−pkg=$(awk -F ":[[:space:]]*" 'tolower($1)=="name" { print $2 }' < "$cabal_file")

20−ver=$(awk -F ":[[:space:]]*" 'tolower($1)=="version" { print $2 }' < "$cabal_file")

21−

22−if [ -z "$pkg" ]; then

23− echo "Unable to determine package name"

24− exit 1

25−fi

26−

27−if [ -z "$ver" ]; then

28− echo "Unable to determine package version"

29− exit 1

30−fi

31−

32−echo "Detected package: $pkg-$ver"

33−

34−dir=$(mktemp -d build-docs.XXXXXX)

35−trap 'rm -r "$dir"' EXIT

36−

37−export PATH=$(stack path --bin-path)

38−

39−ghc --version

40−cabal --version

41−stack --version

42−

43−if haddock --hyperlinked-source >/dev/null

44−then

45− echo "Using fancy hyperlinked source"

46− HYPERLINK_FLAG="--haddock-option=--hyperlinked-source"

47−else

48− echo "Using boring hyperlinked source"

49− HYPERLINK_FLAG="--hyperlink-source"

50−fi

51−

52−# Cabal dist in temporary location

53−builddir=$dir/dist

54−

55−# Build dependencies haddocks with stack, so we get links

56−stack haddock --only-dependencies

57−

58−# Configure using stack databases

59−snapshotpkgdb=$(stack path --snapshot-pkg-db)

60−localpkgdb=$(stack path --local-pkg-db)

61−cabal configure -v2 --builddir=$builddir --package-db=clear --package-db=global --package-db=$snapshotpkgdb --package-db=$localpkgdb

62−

63−# Build Hadckage compatible docs

64−cabal haddock -v2 --builddir=$builddir $HYPERLINK_FLAG --html-location='/package/$pkg-$version/docs' --contents-location='/package/$pkg-$version'

65−

66−# Copy into right directory

67−cp -R $builddir/doc/html/$pkg/ $dir/$pkg-$ver-docs

68−

69−# Tar and gzip

70−tar cvz -C $dir --format=ustar -f $dir/$pkg-$ver-docs.tar.gz $pkg-$ver-docs

71−

72−# Upload

73−curl -X PUT \

74− -H 'Content-Type: application/x-tar' \

75− -H 'Content-Encoding: gzip' \

76− -u "$user" \

77− --data-binary "@$dir/$pkg-$ver-docs.tar.gz" \

78− "https://hackage.haskell.org/package/$pkg-$ver/docs"

index.html.tmpldeleted−119

@@ -1,119 +0,0 @@

1−

2−<!DOCTYPE html>

3−<html>

4−<head>

5− <meta charset="UTF-8">

6− <title>Swagger UI</title>

7− <link rel="icon" type="image/png" href="images/favicon-32x32.png" sizes="32x32" />

8− <link rel="icon" type="image/png" href="images/favicon-16x16.png" sizes="16x16" />

9− <link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>

10− <link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>

11− <link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>

12− <link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/>

13− <link href='css/print.css' media='print' rel='stylesheet' type='text/css'/>

14− <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>

15− <script src='lib/jquery.slideto.min.js' type='text/javascript'></script>

16− <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>

17− <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>

18− <script src='lib/handlebars-2.0.0.js' type='text/javascript'></script>

19− <script src='lib/underscore-min.js' type='text/javascript'></script>

20− <script src='lib/backbone-min.js' type='text/javascript'></script>

21− <script src='swagger-ui.js' type='text/javascript'></script>

22− <script src='lib/highlight.7.3.pack.js' type='text/javascript'></script>

23− <script src='lib/jsoneditor.min.js' type='text/javascript'></script>

24− <script src='lib/marked.js' type='text/javascript'></script>

25− <script src='lib/swagger-oauth.js' type='text/javascript'></script>

26−

27−

28−

29−

30−

31−

32− <script type="text/javascript">

33− $(function () {

34− var url = "SWAGGER_URL_PLACEHOLDER";

35−

36− // Pre load translate...

37− if(window.SwaggerTranslator) {

38− window.SwaggerTranslator.translate();

39− }

40− window.swaggerUi = new SwaggerUi({

41− url: url,

42− dom_id: "swagger-ui-container",

43− supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],

44− onComplete: function(swaggerApi, swaggerUi){

45− if(typeof initOAuth == "function") {

46− initOAuth({

47− clientId: "your-client-id",

48− clientSecret: "your-client-secret-if-required",

49− realm: "your-realms",

50− appName: "your-app-name",

51− scopeSeparator: ",",

52− additionalQueryStringParams: {}

53− });

54− }

55−

56− if(window.SwaggerTranslator) {

57− window.SwaggerTranslator.translate();

58− }

59−

60− $('pre code').each(function(i, e) {

61− hljs.highlightBlock(e)

62− });

63−

64− addApiKeyAuthorization();

65− },

66− onFailure: function(data) {

67− log("Unable to Load SwaggerUI");

68− },

69− docExpansion: "none",

70− jsonEditor: false,

71− apisSorter: "alpha",

72− defaultModelRendering: 'schema',

73− showRequestHeaders: false

74− });

75−

76− function addApiKeyAuthorization(){

77− var key = encodeURIComponent($('#input_apiKey')[0].value);

78− if(key && key.trim() != "") {

79− var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "query");

80− window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);

81− log("added key " + key);

82− }

83− }

84−

85− $('#input_apiKey').change(addApiKeyAuthorization);

86−

87− // if you have an apiKey you would like to pre-populate on the page for demonstration purposes...

88− /*

89− var apiKey = "myApiKeyXXXX123456789";

90− $('#input_apiKey').val(apiKey);

91− */

92−

93− window.swaggerUi.load();

94−

95− function log() {

96− if ('console' in window) {

97− console.log.apply(console, arguments);

98− }

99− }

100− });

101− </script>

102−</head>

103−

104−<body class="swagger-section">

105−<div id='header'>

106− <div class="swagger-ui-wrap">

107− <a id="logo" href="http://swagger.io">swagger</a>

108− <form id='api_selector'>

109− <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>

110− <div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>

111− <div class='input'><a id="explore" href="#" data-sw-translate>Explore</a></div>

112− </form>

113− </div>

114−</div>

115−

116−<div id="message-bar" class="swagger-ui-wrap" data-sw-translate> </div>

117−<div id="swagger-ui-container" class="swagger-ui-wrap"></div>

118−</body>

119−</html>

package.yamldeleted−49

@@ -1,49 +0,0 @@

1−name: servant-swagger-ui

2−version: 0.1.0.2.1.4

3−synopsis: Servant swagger ui

4−description: Provide embedded swagger UI for servant and swagger (i.e. servant-swagger)

5−author: Oleg Grenrus <oleg.grenrus@iki.fi>

6−maintainer: Oleg Grenrus <oleg.grenrus@iki.fi>

7−license: BSD3

8−github: phadej/servant-swagger-ui

9−category: Web

10−tested-with: GHC==7.10.3

11−extra-source-files:

12−- README.md

13−- index.html.tmpl

14−- swagger-dist-2.1.4/**/*

15−

16−ghc-options: -Wall

17−

18−dependencies:

19− - base >=4.7 && <4.9

20− - blaze-markup >=0.7.0.2 && <0.8

21− - bytestring >=0.10.4.0 && <0.11

22− - directory >=1.2.1.0 && <1.3

23− - file-embed >=0.0.8.2 && <0.1

24− - filepath >=1.3.0.2 && <1.5

25− - http-media >=0.6.2 && <0.7

26− - servant >=0.4.4.5 && <0.5

27− - servant-blaze >=0.4.4.5 && <0.5

28− - servant-server >=0.4.4.5 && <0.5

29− - servant-swagger >=1.0.1 && <1.1

30− - swagger2 >=2.0.1 && <2.1

31− - template-haskell >=2.9 && <2.11

32− - text >=1.2.0.6 && <1.3

33− - wai-app-static >=3.0.1.1 && <3.2

34−

35−library:

36− source-dirs: src

37−

38−tests:

39− example:

40− main: Main.hs

41− source-dirs: example

42− dependencies:

43− - servant-swagger-ui

44− - servant-server >=0.4.4.5 && <0.5

45− - aeson >=0.8.0.2 && <0.11

46− - base-compat >=0.6.0 && <0.10

47− - lens >=4.7.0.1 && <4.14

48− - wai >=3.0.3.0 && <3.3

49− - warp >=3.0.13.1 && <3.3

screenshot.pngnew file

Binary file not shown.

servant-swagger-ui-core/Changelog.mdnew file+7

@@ -0,0 +1,7 @@

1+# 0.3.3

3+- Add `swaggerSchemaUIServerImpl'`

5+# 0.3.1

7+- Support `servant-0.14`

LICENSE → servant-swagger-ui-core/LICENSErenamed

The content is the same.

servant-swagger-ui-core/servant-swagger-ui-core.cabalnew file+54

@@ -0,0 +1,54 @@

1+cabal-version: 1.12

2+name: servant-swagger-ui-core

3+version: 0.3.3

4+x-revision: 4

5+synopsis: Servant swagger ui core components

6+category: Web, Servant, Swagger

7+description:

8+ Provide embedded swagger UI for servant and swagger (i.e. servant-swagger)

9+ .

10+ See servant-swagger-ui, servant-swagger-ui-jensoleg or

11+ servant-swagger-ui-redoc for "concrete" implementations.

12+

13+homepage: https://github.com/haskell-servant/servant-swagger-ui

14+bug-reports:

15+ https://github.com/haskell-servant/servant-swagger-ui/issues

16+

17+author: Oleg Grenrus <oleg.grenrus@iki.fi>

18+maintainer: haskell-servant-maintainers@googlegroups.com

19+license: BSD3

20+license-file: LICENSE

21+build-type: Simple

22+tested-with:

23+ GHC ==8.0.2

24+ || ==8.2.2

25+ || ==8.4.4

26+ || ==8.6.5

27+ || ==8.8.4

28+ || ==8.10.2

29+

30+extra-source-files: Changelog.md

31+

32+source-repository head

33+ type: git

34+ location: https://github.com/haskell-servant/servant-swagger-ui

35+

36+library

37+ hs-source-dirs: src

38+ ghc-options: -Wall

39+ build-depends:

40+ base >=4.7 && <4.15

41+ , blaze-markup >=0.7.0.2 && <0.9

42+ , bytestring >=0.10.4.0 && <0.11

43+ , http-media >=0.7.1.3 && <0.9

44+ , servant >=0.14 && <0.19

45+ , servant-blaze >=0.8 && <0.10

46+ , servant-server >=0.14 && <0.19

47+ , swagger2 >=2.3.0.1 && <2.7

48+ , text >=1.2.3.0 && <1.3

49+ , transformers >=0.3 && <0.6

50+ , transformers-compat >=0.3 && <0.7

51+ , wai-app-static >=3.0.1.1 && <3.2

52+

53+ exposed-modules: Servant.Swagger.UI.Core

54+ default-language: Haskell2010

servant-swagger-ui-core/src/Servant/Swagger/UI/Core.hsnew file+120

@@ -0,0 +1,120 @@

1+{-# LANGUAGE ConstraintKinds #-}

2+{-# LANGUAGE DataKinds #-}

3+{-# LANGUAGE DeriveGeneric #-}

4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}

5+{-# LANGUAGE MultiParamTypeClasses #-}

6+{-# LANGUAGE OverloadedStrings #-}

7+{-# LANGUAGE ScopedTypeVariables #-}

8+{-# LANGUAGE TypeFamilies #-}

9+{-# LANGUAGE TypeOperators #-}

10+{-# LANGUAGE UndecidableInstances #-}

11+-----------------------------------------------------------------------------

12+--

13+-- Provides 'SwaggerUI' and corresponding 'swaggerUIServer' to embed

14+-- <http://swagger.io/swagger-ui/ swagger ui> into the application.

15+--

16+-- All of UI files are embedded into the binary.

17+--

18+-- /An example:/

19+--

20+-- @

21+-- -- | Actual API.

22+-- type BasicAPI = Get '[PlainText, JSON] Text

23+-- :\<|> "cat" :> Capture ":name" CatName :> Get '[JSON] Cat

24+--

25+-- -- | API type with bells and whistles, i.e. schema file and swagger-ui.

26+-- type API = 'SwaggerSchemaUI' "swagger-ui" "swagger.json"

27+-- :\<|> BasicAPI

28+--

29+-- -- | Servant server for an API

30+-- server :: Server API

31+-- server = 'swaggerSchemaUIServer' swaggerDoc

32+-- :\<|> (pure "Hello World" :\<|> catEndpoint)

33+-- where

34+-- catEndpoint name = pure $ Cat name False

35+-- @

36+

37+module Servant.Swagger.UI.Core (

38+ -- * Swagger UI API

39+ SwaggerSchemaUI,

40+ SwaggerSchemaUI',

41+

42+ -- * Implementation details

43+ SwaggerUiHtml(..),

44+ swaggerSchemaUIServerImpl,

45+ swaggerSchemaUIServerImpl',

46+ Handler,

47+ ) where

48+

49+import Data.ByteString (ByteString)

50+import Data.Swagger (Swagger)

51+import GHC.TypeLits (KnownSymbol, Symbol, symbolVal)

52+import Network.Wai.Application.Static (embeddedSettings, staticApp)

53+import Servant

54+import Servant.HTML.Blaze (HTML)

55+import Text.Blaze (ToMarkup (..))

56+

57+import qualified Data.Text as T

58+

59+-- | Swagger schema + ui api.

60+--

61+-- @SwaggerSchemaUI "swagger-ui" "swagger.json"@ will result into following hierarchy:

62+--

63+-- @

64+-- \/swagger.json

65+-- \/swagger-ui

66+-- \/swagger-ui\/index.html

67+-- \/swagger-ui\/...

68+-- @

69+--

70+type SwaggerSchemaUI (dir :: Symbol) (schema :: Symbol) =

71+ SwaggerSchemaUI' dir (schema :> Get '[JSON] Swagger)

72+

73+-- | Use 'SwaggerSchemaUI'' when you need even more control over

74+-- where @swagger.json@ is served (e.g. subdirectory).

75+type SwaggerSchemaUI' (dir :: Symbol) (api :: *) =

76+ api

77+ :<|> dir :>

78+ ( Get '[HTML] (SwaggerUiHtml dir api)

79+ :<|> "index.html" :> Get '[HTML] (SwaggerUiHtml dir api)

80+ :<|> Raw

81+ )

82+

83+-- | Index file for swagger ui.

84+--

85+-- It's configured by the location of swagger schema and directory it lives under.

86+--

87+-- Implementation detail: the @index.html@ is prepopulated with parameters

88+-- to find schema file automatically.

89+data SwaggerUiHtml (dir :: Symbol) (api :: *) = SwaggerUiHtml T.Text

90+

91+instance (KnownSymbol dir, HasLink api, Link ~ MkLink api Link, IsElem api api)

92+ => ToMarkup (SwaggerUiHtml dir api)

93+ where

94+ toMarkup (SwaggerUiHtml template) = preEscapedToMarkup

95+ $ T.replace "SERVANT_SWAGGER_UI_SCHEMA" schema

96+ $ T.replace "SERVANT_SWAGGER_UI_DIR" dir

97+ $ template

98+ where

99+ schema = T.pack $ uriPath . linkURI $ safeLink proxyApi proxyApi

100+ dir = T.pack $ symbolVal (Proxy :: Proxy dir)

101+ proxyApi = Proxy :: Proxy api

102+

103+swaggerSchemaUIServerImpl

104+ :: (Server api ~ Handler Swagger)

105+ => T.Text -> [(FilePath, ByteString)]

106+ -> Swagger -> Server (SwaggerSchemaUI' dir api)

107+swaggerSchemaUIServerImpl indexTemplate files swagger

108+ = swaggerSchemaUIServerImpl' indexTemplate files $ return swagger

109+

110+-- | Use a custom server to serve the Swagger spec source.

111+swaggerSchemaUIServerImpl'

112+ :: T.Text -> [(FilePath, ByteString)]

113+ -> Server api -> Server (SwaggerSchemaUI' dir api)

114+swaggerSchemaUIServerImpl' indexTemplate files server

115+ = server

116+ :<|> return (SwaggerUiHtml indexTemplate)

117+ :<|> return (SwaggerUiHtml indexTemplate)

118+ :<|> rest

119+ where

120+ rest = Tagged $ staticApp $ embeddedSettings files

servant-swagger-ui-example/LICENSEnew file+30

@@ -0,0 +1,30 @@

5+Redistribution and use in source and binary forms, with or without

6+modification, are permitted provided that the following conditions are met:

8+ * Redistributions of source code must retain the above copyright

9+ notice, this list of conditions and the following disclaimer.

10+

11+ * Redistributions in binary form must reproduce the above

12+ copyright notice, this list of conditions and the following

13+ disclaimer in the documentation and/or other materials provided

14+ with the distribution.

15+

16+ * Neither the name of Oleg Grenrus nor the names of other

17+ contributors may be used to endorse or promote products derived

18+ from this software without specific prior written permission.

19+

20+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

21+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

22+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

23+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

24+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

25+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

26+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

27+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

28+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

29+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

30+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Setup.hs → servant-swagger-ui-example/Setup.hsrenamed−1

@@ -1,3 +1,2 @@

11import Distribution.Simple

2−main :: IO ()

32main = defaultMain

servant-swagger-ui-example/servant-swagger-ui-example.cabalnew file+49

@@ -0,0 +1,49 @@

1+cabal-version: 2.0

2+name: servant-swagger-ui-example

3+version: 0

4+synopsis: servant-swagger-ui example

5+category: Web, Servant, Swagger

6+description: A kind of test-suite of servant-swagger-ui

7+homepage: https://github.com/haskell-servant/servant-swagger-ui

8+bug-reports:

9+ https://github.com/haskell-servant/servant-swagger-ui/issues

10+

11+author: Oleg Grenrus <oleg.grenrus@iki.fi>

12+maintainer: haskell-servant-maintainers@googlegroups.com

13+license: BSD3

14+license-file: LICENSE

15+build-type: Simple

16+tested-with:

17+ GHC ==8.0.2

18+ || ==8.2.2

19+ || ==8.4.4

20+ || ==8.6.5

21+ || ==8.8.4

22+ || ==8.10.2

23+

24+source-repository head

25+ type: git

26+ location: https://github.com/haskell-servant/servant-swagger-ui

27+

28+executable servant-swagger-ui-example

29+ main-is: Main.hs

30+ ghc-options: -threaded

31+ build-depends:

32+ aeson >=0.8.0.2 && <1.6

33+ , base >=4.7 && <4.15

34+ , base-compat >=0.9.3 && <0.12

35+ , lens >=4.7.0.1 && <4.20

36+ , servant

37+ , servant-server

38+ , servant-swagger

39+ , servant-swagger-ui

40+ , servant-swagger-ui-core

41+ , servant-swagger-ui-jensoleg

42+ , servant-swagger-ui-redoc

43+ , swagger2

44+ , text

45+ , wai >=3.0.3.0 && <3.3

46+ , warp >=3.0.13.1 && <3.4

47+

48+ hs-source-dirs: src

49+ default-language: Haskell2010

servant-swagger-ui-example/src/Main.hsnew file+213

@@ -0,0 +1,213 @@

1+{-# LANGUAGE CPP #-}

2+{-# LANGUAGE DataKinds #-}

3+{-# LANGUAGE DeriveGeneric #-}

4+{-# LANGUAGE FlexibleInstances #-}

5+{-# LANGUAGE GeneralizedNewtypeDeriving #-}

6+{-# LANGUAGE MultiParamTypeClasses #-}

7+{-# LANGUAGE OverloadedStrings #-}

8+{-# LANGUAGE ScopedTypeVariables #-}

9+{-# LANGUAGE TypeFamilies #-}

10+{-# LANGUAGE TypeOperators #-}

11+{-# LANGUAGE UndecidableInstances #-}

12+{-# OPTIONS_GHC -fno-warn-orphans #-}

13+module Main (main, catIsMale, catName) where

14+

15+import Prelude ()

16+import Prelude.Compat

17+

18+import Control.Lens hiding ((.=))

19+import Data.Aeson (FromJSON, ToJSON)

20+import Data.Maybe (fromMaybe)

21+import Data.String (IsString (..))

22+import Data.Text (Text)

23+import GHC.Generics (Generic)

24+import Network.Wai (Application)

25+import System.Environment (getArgs, lookupEnv)

26+import Text.Read (readMaybe)

27+

28+import Data.Swagger

29+import Servant

30+import Servant.Swagger

31+import Servant.Swagger.UI

32+import Servant.Swagger.UI.Core

33+import Servant.Swagger.UI.JensOleG

34+import Servant.Swagger.UI.ReDoc

35+

36+import qualified Network.Wai.Handler.Warp as Warp

37+

38+#if MIN_VERSION_servant(0,12,0)

39+#define SUMMARY(d) Summary d :>

40+#else

41+#define SUMMARY(d)

42+#endif

43+

44+#if MIN_VERSION_servant(0,13,0)

45+#if __GLASGOW_HASKELL__ >= 802 && MIN_VERSION_base(4,10,0)

46+import GHC.Generics (D1, Meta (..), Rep)

47+import GHC.TypeLits (AppendSymbol, Symbol)

48+#endif

49+#endif

50+

51+-- data types

52+data Cat = Cat { catName :: CatName, catIsMale :: Bool }

53+ deriving (Generic, Show)

54+

55+newtype CatName = CatName Text

56+ deriving ( Eq, Show, Generic

57+#if MIN_VERSION_servant(0,5,0)

58+ , FromHttpApiData

59+#else

60+ , FromText

61+#endif

62+ )

63+

64+instance IsString CatName where

65+ fromString = CatName . fromString

66+

67+-- swagger instances

68+instance ToJSON Cat

69+instance ToJSON CatName

70+instance FromJSON Cat

71+instance FromJSON CatName

72+instance ToParamSchema CatName

73+instance ToSchema Cat

74+instance ToSchema CatName

75+

76+-- api

77+

78+#if MIN_VERSION_servant(0,13,0)

79+#if __GLASGOW_HASKELL__ >= 802 && MIN_VERSION_base(4,10,0)

80+-- | Get a typename as type-level 'Symbol'.

81+--

82+-- Few non-Generic things are hard-coded, for else we fallback to 'Generic'

83+--

84+-- >>> :kind! TypeName Int

85+-- TypeName Int :: Symbol

86+-- = "Int"

87+--

88+-- >>> :kind! TypeName CatName

89+-- TypeName CatName :: Symbol

90+-- = "CatName"

91+--

92+-- Unfortunately we cannot use 'TypeError' for other cases,

93+-- as 'Rep' isn't reduced so 'GenericTypeName' cannot fall past first

94+-- equation. So you will get somewhat obscure errors saying

95+-- "no instance for (KnownSymbol ... (GenericTypeName YourNonGenericType ..."

96+--

97+-- >>> :kind! TypeName Float

98+-- TypeName Float :: Symbol

99+-- = GenericTypeName Float (Rep Float ())

100+--

101+-- It would be nice if there were such type family for 'Typeable', i.e. all

102+-- types :)

103+--

104+type family TypeName (x :: *) :: Symbol where

105+ TypeName Int = "Int"

106+ TypeName Text = "Text"

107+ TypeName x = GenericTypeName x (Rep x ())

108+

109+type family GenericTypeName t (r :: *) :: Symbol where

110+ GenericTypeName t (D1 ('MetaData name mod pkg nt) f x) = name

111+

112+type Desc t n = Description (AppendSymbol (TypeName t) (AppendSymbol " | " n))

113+#else

114+type Desc t n = Description n

115+#endif

116+#endif

117+

118+type FirstCatEndpoint =

119+#if MIN_VERSION_servant(0,13,0)

120+ "cat"

121+ :> Summary "First cat endpoint"

122+ :> Capture' '[Desc CatName "Cat's name"] ":name" CatName

123+ :> QueryParam' '[Required, Desc Int "Random number"] "num" Int

124+ :> QueryParam' '[Optional, Desc Text "Random text"] "text" Text

125+ :> Get '[JSON] Cat

126+#else

127+ "cat" :> Capture ":name" CatName

128+ :> QueryParam "num" Int :> QueryParam "text" Text :> Get '[JSON] Cat

129+#endif

130+

131+type BasicAPI = Get '[PlainText, JSON] Text

132+ :<|> FirstCatEndpoint

133+ :<|> SUMMARY("Second cat") "cat2" :> Capture ":name" CatName :> Get '[JSON] Cat

134+ :<|> SUMMARY("Third cat") "cat3" :> Capture ":name" CatName :> Get '[JSON] Cat

135+ :<|> SUMMARY("Post endpoint") "post-cat" :> ReqBody '[JSON] Cat :> Post '[JSON] Cat

136+

137+type API =

138+ -- this serves both: swagger.json and swagger-ui

139+ SwaggerSchemaUI "swagger-ui" "swagger.json"

140+ :<|> BasicAPI

141+

142+-- To test nested case

143+type API' = API

144+ :<|> "nested" :> API

145+ :<|> SwaggerSchemaUI' "foo-ui" ("foo" :> "swagger.json" :> Get '[JSON] Swagger)

146+

147+-- Implementation

148+

149+-- | We test different ways to nest API, so we have an enumeration

150+data Variant

151+ = Normal

152+ | Nested

153+ | SpecDown

154+ deriving (Eq)

155+

156+data UIFlavour

157+ = Original

158+ | JensOleG

159+ | ReDoc

160+ deriving (Eq)

161+

162+server' :: UIFlavour -> Server API'

163+server' uiFlavour = server Normal

164+ :<|> server Nested

165+ :<|> schemaUiServer (swaggerDoc' SpecDown)

166+ where

167+ server :: Variant -> Server API

168+ server variant =

169+ schemaUiServer (swaggerDoc' variant)

171+ where

172+ catEndpoint' n _ _ = return $ Cat n (variant == Normal)

173+ catEndpoint n = return $ Cat n (variant == Normal)

174+ -- Unfortunately we have to specify the basePath manually atm.

175+

176+ schemaUiServer

177+ :: (Server api ~ Handler Swagger)

178+ => Swagger -> Server (SwaggerSchemaUI' dir api)

179+ schemaUiServer = case uiFlavour of

180+ Original -> swaggerSchemaUIServer

181+ JensOleG -> jensolegSwaggerSchemaUIServer

182+ ReDoc -> redocSchemaUIServer

183+

184+ swaggerDoc' Normal = swaggerDoc

185+ swaggerDoc' Nested = swaggerDoc

186+ & basePath ?~ "/nested"

187+ & info.description ?~ "Nested API"

188+ swaggerDoc' SpecDown = swaggerDoc

189+ & info.description ?~ "Spec nested"

190+

191+-- Boilerplate

192+

193+swaggerDoc :: Swagger

194+swaggerDoc = toSwagger (Proxy :: Proxy BasicAPI)

195+ & info.title .~ "Cats API"

196+ & info.version .~ "2016.8.7"

197+ & info.description ?~ "This is an API that tests servant-swagger support"

198+

199+api :: Proxy API'

200+api = Proxy

201+

202+app :: UIFlavour -> Application

203+app = serve api . server'

204+

205+main :: IO ()

206+main = do

207+ args <- getArgs

208+ let uiFlavour | "jensoleg" `elem` args = JensOleG

209+ | "redoc" `elem` args = ReDoc

210+ | otherwise = Original

211+ p <- fromMaybe 8000 . (>>= readMaybe) <$> lookupEnv "PORT"

212+ putStrLn $ "http://localhost:" ++ show p ++ "/"

213+ Warp.run p (app uiFlavour)

servant-swagger-ui-jensoleg/LICENSEnew file+45

@@ -0,0 +1,45 @@