Update example, add to CI

Author: maksbotan

.travis.yml

@@ -90,17 +90,21 @@ install:
   - touch cabal.project
   - |
     echo "packages: ." >> cabal.project
+    echo "packages: example" >> cabal.project
   - echo 'package servant-openapi3' >> cabal.project
   - "echo '  ghc-options: -Werror=missing-methods' >> cabal.project"
+  - echo 'package example' >> cabal.project
+  - "echo '  ghc-options: -Werror=missing-methods' >> cabal.project"
   - |
     echo "source-repository-package"                            >> cabal.project
     echo "  type:     git"                                      >> cabal.project
     echo "  location: https://github.com/biocad/openapi3/"      >> cabal.project
     echo "  tag:      bd9df532f2381c4b22fe86ef722715088f5cfa68" >> cabal.project
-  - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(servant-openapi3)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
+  - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(example|servant-openapi3)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
   - cat cabal.project || true
   - cat cabal.project.local || true
   - if [ -f "./configure.ac" ]; then (cd "." && autoreconf -i); fi
+  - if [ -f "example/configure.ac" ]; then (cd "example" && autoreconf -i); fi
   - ${CABAL} v2-freeze $WITHCOMPILER ${TEST} ${BENCH}
   - "cat cabal.project.freeze | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"
   - rm  cabal.project.freeze
@@ -116,19 +120,23 @@ script:
   - find . -maxdepth 1 -type f -name '*.tar.gz' -exec tar -xvf '{}' \;
   - find . -maxdepth 1 -type f -name '*.tar.gz' -exec rm       '{}' \;
   - PKGDIR_servant_openapi3="$(find . -maxdepth 1 -type d -regex '.*/servant-openapi3-[0-9.]*')"
+  - PKGDIR_example="$(find . -maxdepth 1 -type d -regex '.*/example-[0-9.]*')"
   # Generate cabal.project
   - rm -rf cabal.project cabal.project.local cabal.project.freeze
   - touch cabal.project
   - |
     echo "packages: ${PKGDIR_servant_openapi3}" >> cabal.project
+    echo "packages: ${PKGDIR_example}" >> cabal.project
   - echo 'package servant-openapi3' >> cabal.project
   - "echo '  ghc-options: -Werror=missing-methods' >> cabal.project"
+  - echo 'package example' >> cabal.project
+  - "echo '  ghc-options: -Werror=missing-methods' >> cabal.project"
   - |
     echo "source-repository-package"                            >> cabal.project
     echo "  type:     git"                                      >> cabal.project
     echo "  location: https://github.com/biocad/openapi3/"      >> cabal.project
     echo "  tag:      bd9df532f2381c4b22fe86ef722715088f5cfa68" >> cabal.project
-  - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(servant-openapi3)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
+  - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(example|servant-openapi3)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
   - cat cabal.project || true
   - cat cabal.project.local || true
   # Building...
@@ -141,6 +149,7 @@ script:
   - ${CABAL} v2-test $WITHCOMPILER ${TEST} ${BENCH} all
   # cabal check...
   - (cd ${PKGDIR_servant_openapi3} && ${CABAL} -vnormal check)
+  - (cd ${PKGDIR_example} && ${CABAL} -vnormal check)
   # haddock...
   - ${CABAL} v2-haddock $WITHCOMPILER --with-haddock $HADDOCK ${TEST} ${BENCH} all
   # Building without installed constraints for packages in global-db...

cabal.project

@@ -1,5 +1,6 @@
 packages:
-    servant-openapi3.cabal
+    servant-openapi3.cabal,
+    example/example.cabal
 tests: true
 
 source-repository-package

example/example.cabal

@@ -1,18 +1,23 @@
 name:                example
 version:             1.0
-synopsis:            servant-swagger demonstration
-description:         servant-swagger demonstration
+synopsis:            servant-openapi3 demonstration
+description:         servant-openapi3 demonstration
 license:             BSD3
 license-file:        LICENSE
 author:              David Johnson, Nickolay Kudasov
 maintainer:          [email protected]
-copyright:           (c) 2015-2016, Servant contributors
+copyright:           (c) 2015-2020, Servant contributors
 category:            Web
 build-type:          Simple
 cabal-version:       >=1.10
 data-files:
   swagger.json
 
+tested-with:
+  GHC ==8.4.4
+   || ==8.6.5
+   || ==8.8.3
+
 library
   ghc-options:      -Wall
   hs-source-dirs: src/
@@ -25,8 +30,8 @@ library
                 , lens
                 , servant
                 , servant-server
-                , servant-swagger
-                , swagger2
+                , servant-openapi3
+                , openapi3
                 , text
                 , time
   default-language: Haskell2010
@@ -55,7 +60,7 @@ test-suite swagger-server-spec
                   , bytestring
                   , example
                   , hspec
-                  , servant-swagger
+                  , servant-openapi3
                   , QuickCheck
                   , quickcheck-instances
   default-language: Haskell2010

example/src/Todo.hs

@@ -10,14 +10,14 @@ import           Control.Lens
 import           Data.Aeson
 import           Data.Aeson.Encode.Pretty   (encodePretty)
 import qualified Data.ByteString.Lazy.Char8 as BL8
+import           Data.OpenApi               hiding (Server)
 import           Data.Proxy
-import           Data.Swagger
 import           Data.Text                  (Text)
 import           Data.Time                  (UTCTime (..), fromGregorian)
 import           Data.Typeable              (Typeable)
 import           GHC.Generics
 import           Servant
-import           Servant.Swagger
+import           Servant.OpenApi
 
 todoAPI :: Proxy TodoAPI
 todoAPI = Proxy
@@ -30,7 +30,7 @@ type TodoAPI
  :<|> "todo" :> Capture "id" TodoId :> ReqBody '[JSON] Todo :> Put '[JSON] TodoId
 
 -- | API for serving @swagger.json@.
-type SwaggerAPI = "swagger.json" :> Get '[JSON] Swagger
+type SwaggerAPI = "swagger.json" :> Get '[JSON] OpenApi
 
 -- | Combined API of a Todo service with Swagger documentation.
 type API = SwaggerAPI :<|> TodoAPI
@@ -57,8 +57,8 @@ instance ToParamSchema TodoId
 instance ToSchema TodoId
 
 -- | Swagger spec for Todo API.
-todoSwagger :: Swagger
-todoSwagger = toSwagger todoAPI
+todoSwagger :: OpenApi
+todoSwagger = toOpenApi todoAPI
   & info.title   .~ "Todo API"
   & info.version .~ "1.0"
   & info.description ?~ "This is an API that tests swagger integration"