servant

A family of combinators for defining webservices APIs

http://haskell-servant.readthedocs.org/

Version on this page:	0.7.1
LTS Haskell 23.21:	0.20.2@rev:1
Stackage Nightly 2025-05-04:	0.20.2@rev:1
Latest on Hackage:	0.20.2@rev:1

See all snapshots servant appears in

BSD-3-Clause licensed by Servant Contributors

Maintained by [email protected]

This version can be pinned in stack with:servant-0.7.1@sha256:449d9525e13efe6e27b844e09900dd68ae0230c97c38cc1e90afbd1f69a5ea35,3784

Module documentation for 0.7.1

Servant
- Servant.API
  - Servant.API.Alternative
  - Servant.API.BasicAuth
  - Servant.API.Capture
  - Servant.API.ContentTypes
  - Servant.API.Experimental
    - Servant.API.Experimental.Auth
  - Servant.API.Header
  - Servant.API.HttpVersion
  - Servant.API.Internal
    - Servant.API.Internal.Test
      - Servant.API.Internal.Test.ComprehensiveAPI
  - Servant.API.IsSecure
  - Servant.API.QueryParam
  - Servant.API.Raw
  - Servant.API.RemoteHost
  - Servant.API.ReqBody
  - Servant.API.ResponseHeaders
  - Servant.API.Sub
  - Servant.API.Vault
  - Servant.API.Verbs
  - Servant.API.WithNamedContext
- Servant.Utils
  - Servant.Utils.Enter
  - Servant.Utils.Links

Depends on 16 packages(full list with versions):

aeson, attoparsec, base, base-compat, bytestring, bytestring-conversion, case-insensitive, http-api-data, http-media, http-types, mmorph, mtl, network-uri, string-conversions, text, vault

Used by 18 packages in lts-6.0(full list with versions):

avers-api, avers-server, dixi, giphy-api, lackey, servant-blaze, servant-cassava, servant-client, servant-docs, servant-foreign, servant-js, servant-JuicyPixels, servant-lucid, servant-mock, servant-server, servant-swagger, servant-yaml, telegram-api

A family of combinators for defining webservices APIs and serving them

You can learn about the basics in the tutorial.

Changes

0.7.1

Add module Servant.Utils.Enter (https://github.com/haskell-servant/servant/pull/478)
Allow to set the same header multiple times in responses.

0.5

Add WithNamedConfig combinator.
Add HttpVersion, IsSecure, RemoteHost and Vault combinators
Fix safeLink, so Header is not in fact required.
Add more instances for (:<|>)
Use http-api-data instead of Servant.Common.Text
Remove matrix params.
Add PlainText String MimeRender and MimeUnrender instances.
Add new Verbs combinator, and make all existing and new verb combinators type synonyms of it.
Add BasicAuth combinator to support Basic authentication
Add generalized authentication support

0.4.2

Fix missing cases for Patch in safeLink

0.4.1

Allow whitespace after parsing JSON
Stricter matching for safeLink for Capture

0.4

Delete now is like Get, Post, Put, and Patch and returns a response body
Multiple content-type/accept support for all the relevant combinators
Provide JSON, PlainText, OctetStream and FormUrlEncoded content types out of the box
Type-safe link generation to API endpoints
Support for the PATCH HTTP method
Removed the home-made QuasiQuote for writing API types in a more human-friendly format until we come up with a better design for it
Make most if not all of the haddock code examples run through doctest
Some general code cleanup
Add response headers