@hackage swagger-petstore0.0.1.0

Auto-generated swagger-petstore API Client

Swagger Auto-Generated http-client Bindings to SwaggerPetstore

The library in lib provides auto-generated-from-Swagger http-client bindings to the SwaggerPetstore API.

Targeted swagger version: 2.0

OpenAPI-Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

Installation

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

  1. Install the Haskell stack tool.
  2. To build the package, and generate the documentation (recommended): 
stack haddock

which will generate docs for this lib in the docs folder.

To generate the docs in the normal location (to enable hyperlinks to external libs), remove

build:
  haddock-arguments:
    haddock-args:
    - "--odir=./docs"

from the stack.yaml file and run stack haddock again.

  1. To run unit tests: 
stack test

Swagger-Codegen

The code generator that produced this library, and which explains how to obtain and use the swagger-codegen cli tool lives at

https://github.com/swagger-api/swagger-codegen

The language argument (--lang) passed to the cli tool used should be

haskell-http-client

Unsupported Swagger Features

This is beta software; other cases may not be supported.

Codegen "config option" parameters

These options allow some customization of the code generation process.

haskell-http-client specific options:

OPTION DESCRIPTION DEFAULT ACTUAL
allowFromJsonNulls allow JSON Null during model decoding from JSON true true
allowToJsonNulls allow emitting JSON Null during model encoding to JSON false false
dateFormat format string used to parse/render a date %Y-%m-%d
dateTimeFormat format string used to parse/render a datetime. (Defaults to formatISO8601Millis when not provided)
generateFormUrlEncodedInstances Generate FromForm/ToForm instances for models used by x-www-form-urlencoded operations (model fields must be primitive types) true true
generateLenses Generate Lens optics for Models true true
generateModelConstructors Generate smart constructors (only supply required fields) for models true true
modelDeriving Additional classes to include in the deriving() clause of Models

View the full list of Codegen "config option" parameters with the command:

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l haskell-http-client

Example SwaggerPetstore Haddock documentation

An example of the generated haddock documentation targeting the server http://petstore.swagger.io/ (SwaggerPetstore) can be found here

Example SwaggerPetstore App

An example application using the auto-generated haskell-http-client bindings for the server http://petstore.swagger.io/ can be found here

Usage Notes

This library is intended to be imported qualified.

MODULE NOTES
SwaggerPetstore.Client use the "dispatch" functions to send requests
SwaggerPetstore.API construct requetss
SwaggerPetstore.Model describes models
SwaggerPetstore.MimeTypes encoding/decoding MIME types (content-types/accept)
SwaggerPetstore.Lens lenses & traversals for model fields

This library adds type safety around what swagger specifies as Produces and Consumes for each Operation (e.g. the list of MIME types an Operation can Produce (using 'accept' headers) and Consume (using 'content-type' headers).

For example, if there is an Operation named addFoo, there will be a data type generated named AddFoo (note the capitalization) which describes additional constraints and actions on the addFoo operation, which can be viewed in GHCi or via the Haddocks.

  • requried parameters are included as function arguments to addFoo
  • optional non-body parameters are included by using applyOptionalParam
  • optional body parameters are set by using setBodyParam

Example for pretend addFoo operation:

data AddFoo 	
instance Consumes AddFoo MimeJSON
instance Produces AddFoo MimeJSON
instance Produces AddFoo MimeXML
instance HasBodyParam AddFoo FooModel
instance HasOptionalParam AddFoo FooName
instance HasOptionalParam AddFoo FooId

this would indicate that:

  • the addFoo operation can consume JSON
  • the addFoo operation produces JSON or XML, depending on the argument passed to the dispatch function
  • the addFoo operation can set it's body param of FooModel via setBodyParam
  • the addFoo operation can set 2 different optional parameters via applyOptionalParam

putting this together:

let addFooRequest = addFoo MimeJSON foomodel requiredparam1 requiredparam2
  `applyOptionalParam` FooId 1
  `applyOptionalParam` FooName "name"
  `setHeader` [("api_key","xxyy")]
addFooResult <- dispatchMime mgr config addFooRequest MimeXML

If the swagger spec doesn't declare it can accept or produce a certain MIME type for a given Operation, you should either add a Produces or Consumes instance for the desired MIME types (assuming the server supports it), use dispatchLbsUnsafe or modify the swagger spec and run the generator again.

New MIME type instances can be added via MimeType/MimeRender/MimeUnrender

Only JSON instances are generated by default, and in some case x-www-form-urlencoded instances (FromFrom, ToForm) will also be generated if the model fields are primitive types, and there are Operations using x-www-form-urlencoded which use those models.

See the example app and the haddocks for details.