openapi-generator-original/samples/server/others/haskell-servant-ping/README.md

Auto-Generated OpenAPI Bindings to PingTest

The library in lib provides auto-generated-from-OpenAPI bindings to the PingTest API.

Installation

Installation follows the standard approach to installing Stack-based projects.

1. Install the Haskell stack tool.
2. Run stack install to install this package.

Otherwise, if you already have a Stack project, you can include this package under the packages key in your stack.yaml:

packages:
- location:
    git: https://github.com/yourGitOrg/yourGitRepo
    commit: somecommit

Main Interface

The main interface to this library is in the PingTest.API module, which exports the PingTestBackend type. The PingTestBackend type can be used to create and define servers and clients for the API.

Creating a Client

A client can be created via the createPingTestClient function, which will generate a function for every endpoint of the API. Then these functions can be invoked with runPingTestClientWithManager or more conveniently with callPingTestClient (depending if you want an Either back or you want to catch) to access the API endpoint they refer to, if the API is served at the url you specified.

For example, if localhost:8080 is serving the PingTest API, you can write:

{-# LANGUAGE RecordWildCards #-}

import PingTest.API as API

import           Network.HTTP.Client     (newManager)
import           Network.HTTP.Client.TLS (tlsManagerSettings)
import           Servant.Client          (ClientEnv, mkClientEnv, parseBaseUrl)


main :: IO ()
main = do
  -- Configure the BaseUrl for the client
  url <- parseBaseUrl "http://localhost:8080/"

  -- You probably want to reuse the Manager across calls, for performance reasons
  manager <- newManager tlsManagerSettings

  -- Create the client (all endpoint functions will be available)
  let PingTestBackend{..} = API.createPingTestClient

  -- Any PingTest API call can go here, e.g. here we call `getSomeEndpoint`
  API.callPingTest (mkClientEnv manager url) getSomeEndpoint

Creating a Server

In order to create a server, you must use the runPingTestMiddlewareServer function. However, you unlike the client, in which case you got a PingTestBackend from the library, you must instead provide a PingTestBackend. For example, if you have defined handler functions for all the functions in PingTest.Handlers, you can write:

{-# LANGUAGE RecordWildCards #-}

import PingTest.API
-- required dependency: wai
import Network.Wai (Middleware)
-- required dependency: wai-extra
import Network.Wai.Middleware.RequestLogger (logStdout)

-- A module you wrote yourself, containing all handlers needed for the PingTestBackend type.
import PingTest.Handlers

-- If you would like to not use any middlewares you could use runPingTestServer instead

-- Combined middlewares
requestMiddlewares :: Middleware
requestMiddlewares = logStdout

-- Run a PingTest server on localhost:8080
main :: IO ()
main = do
  let server = PingTestBackend{..}
      config = Config "http://localhost:8080/"
  runPingTestMiddlewareServer config requestMiddlewares server

Authentication

Currently basic, bearer and API key authentication is supported. The API key must be provided in the request header.

For clients authentication the function clientAuth is generated automatically. For basic authentication the argument is of type BasicAuthData provided by Servant.API.BasicAuth. For bearer and API key authentication the argument is the key/token and is of type Text. Protected endpoints on the client will receive an extra argument. The value returned by clientAuth keyTokenOrBasic can then be used to make authenticated requests.

For the server you are free to choose a custom data type. After you specified an instance of AuthServerData it is automatically added as a first argument to protected endpoints:

newtype Account = Account {unAccount :: Text}
type instance AuthServerData Protected = Account

Additionally, you have to provide value for the PingTestAuth type provided by the PingTest.API module:

auth :: PingTestAuth
auth =
  PingTestAuth
    { lookupUser = lookupAccount,
      authError = \request -> err401 {errBody = "Missing header"}
    }

lookupAccount is a user defined function used to verify the key, token or basic auth data. authError takes a Request and returns a ServerError. The value is used by the server functions:

runPingTestMiddlewareServer config requestMiddlewares auth server