openapi-generator/samples/server/petstore/haskell-servant

Auto-Generated Swagger Bindings to SwaggerPetstore

The library in lib provides auto-generated-from-Swagger bindings to the SwaggerPetstore 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.

Main Interface

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

Creating a Client

A client can be created via the createSwaggerPetstoreClient function, which, if provided with a hostname and a port, will generate a client that can be used to access the API if it is being served at that hostname / port combination. For example, if localhost:8080 is serving the SwaggerPetstore API, you can write:

{-# LANGUAGE RecordWildCards #-}

import SwaggerPetstore.API

main :: IO ()
main = do
  SwaggerPetstoreBackend{..} <- createSwaggerPetstoreClient (ServerConfig "localhost" 8080)
  -- Any SwaggerPetstore API call can go here.
  return ()

Creating a Server

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

{-# LANGUAGE RecordWildCards #-}

import SwaggerPetstore.API

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

-- Run a SwaggerPetstore server on localhost:8080
main :: IO ()
main = do
  let server = SwaggerPetstoreBackend{..}
  runSwaggerPetstoreServer (ServerConfig "localhost" 8080) server

You could use optparse-applicative or a similar library to read the host and port from command-line arguments:

{-# LANGUAGE RecordWildCards #-}

module Main (main) where

import SwaggerPetstore.API (runSwaggerPetstoreServer, SwaggerPetstoreBackend(..), ServerConfig(..))

import Control.Applicative ((<$>), (<*>))
import Options.Applicative (execParser, option, str, auto, long, metavar, help)

main :: IO ()
main = do
  config <- parseArguments
  runSwaggerPetstoreServer config SwaggerPetstoreBackend{}

-- | Parse host and port from the command line arguments.
parseArguments :: IO ServerConfig
parseArguments =
  execParser $
    ServerConfig
      <$> option str  (long "host" <> metavar "HOST" <> help "Host to serve on")
      <*> option auto (long "port" <> metavar "PORT" <> help "Port to serve on")