servant-server

A family of combinators for defining webservices APIs and serving them

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

Version on this page:	0.13.0.1@rev:2
LTS Haskell 20.24:	0.19.2@rev:2
Stackage Nightly 2023-06-04:	0.19.2@rev:2
Latest on Hackage:	0.19.2@rev:2

See all snapshots servant-server appears in

BSD-3-Clause licensed by Servant Contributors

Maintained by haskell-servant-maintainers@googlegroups.com

This version can be pinned in stack with:servant-server-0.13.0.1@sha256:57c767bfabb884d211acc5327ca032b1a06a5cd04a07ba478946b28b15a37499,6055

Module documentation for 0.13.0.1

Servant
- Servant.Server
  - Servant.Server.Experimental
    - Servant.Server.Experimental.Auth
  - Servant.Server.Internal
- Servant.Utils
  - Servant.Utils.StaticFiles

Depends on 32 packages(full list with versions):

Used by 13 packages in lts-11.22(full list with versions):

hledger-api, servant-exceptions, servant-generic, servant-github-webhook, servant-js, servant-JuicyPixels, servant-mock, servant-purescript, servant-server, servant-static-th, servant-subscriber, servant-swagger-ui, servant-websockets

servant-server

servant

This library lets you implement an HTTP server with handlers for each endpoint of a servant API, handling most of the boilerplate for you.

Getting started

We’ve written a tutorial guide that introduces the core types and features of servant. After this article, you should be able to write your first servant webservices, learning the rest from the haddocks’ examples.

Changes

The latest version of this document is on GitHub. Changelog for servant package contains significant entries for all core packages.

0.13.0.1

Support base-compat-0.10

0.13

Streaming endpoint support. (#836)
servant Add Servant.API.Modifiers (#873)

0.12

Breaking changes

Added hoistServer member to the HasServer class, which is HasServer specific enter. (#804)

0.11

Breaking changes

Changed HasServer instances for Header to throw 400 when parsing fails (#724)
Added headersD block to Delayed (#724)

Other changes

Add err418, err422 error codes (#739)

0.10

Breaking changes

Handler is now an abstract datatype. Migration hint: change throwE to throwError. (#641)
Changed HasServer instances for QueryParam and QueryParam to throw 400 when parsing fails (#649)

Other changes

Added paramsD block to Delayed
Add err422 Unprocessable Entity (#646)
Deprecate serveDirectory and introduce serveDirectoryFileServer, serveDirectoryWebApp, serveDirectoryWebAppLookup, serveDirectoryEmbedded and serveDirectoryWith which offer 4 default options and a more flexible one for serving static files. (#658)
DelayedIO is an instance of MonadResource, allowing safe resource handling. (#622 , #674 , #675)

0.7.1

Remove module Servant.Server.Internal.Enter (https://github.com/haskell-servant/servant/pull/478)
Support GHC 8.0

0.7

The Router type has been changed. Static router tables should now be properly shared between requests, drastically increasing the number of situations where servers will be able to route requests efficiently. Functions layout and layoutWithContext have been added to visualize the router layout for debugging purposes. Test cases for expected router layouts have been added.
If an endpoint is discovered to have a non-matching “accept header”, this is now a recoverable rather than a fatal failure, allowing different endpoints for the same route, but with different content types to be specified modularly.
Export throwError from module Servant
Add Handler type synonym

0.6.1

If servers use the BasicAuth combinator and receive requests with missing or invalid credentials, the resulting error responses (401 and 403) could be overwritten by subsequent alternative routes. Now BasicAuth uses FailFatal and the error responses can’t be overwritten anymore.

0.6

Query parameters that can’t be parsed result in a 400 (was 404).

0.5

Add Config machinery (https://github.com/haskell-servant/servant/pull/327). This is a breaking change, as the signatures of both route, serve and the typeclass HasServer now take an additional parameter.
Support for the HttpVersion, IsSecure, RemoteHost and Vault combinators
Drop EitherT in favor of ExceptT
Use http-api-data instead of Servant.Common.Text
Remove matrix params.
Remove RouteMismatch.
Redefined constructors of RouteResult.
Added Delayed and related functions (addMethodCheck, addAcceptCheck, addBodyCheck, runDelayed)
Added support for Basic Authentication
Add generalized authentication support via the AuthServerData type family and AuthHandler handler

0.4.1

Bump attoparsec upper bound to < 0.14
Bump wai-app-static upper bound to < 3.2
Bump either upper bound to < 4.5

0.4

Delete now is like Get, Post, Put, and Patch and returns a response body
Add a RouteMismatch constructor for arbitrary HTTP response codes (https://github.com/haskell-servant/servant-server/pull/22)
Add support for the Patch combinator
Support for Accept/Content-type headers and for the content-type aware combinators in servant-0.4
Export toApplication from Servant.Server (https://github.com/haskell-servant/servant-server/pull/29)
Support other Monads than just EitherT (Int, String) IO (https://github.com/haskell-servant/servant-server/pull/21)
Make methods return status code 204 if they return () (https://github.com/haskell-servant/servant-server/issues/28)
Add server support for response headers
Use ServantErr instead of (Int,String) in EitherT handlers
Add errXXX functions for HTTP errors with sensible default reason strings
Add enter function for applying natural transformations to handlers

0.2.4

Added support for matrix parameters, see e.g. http://www.w3.org/DesignIssues/MatrixURIs.html
Add support for serializing based on Accept header (https://github.com/haskell-servant/servant-server/issues/9)
Ignore trailing slashes (https://github.com/haskell-servant/servant-server/issues/5)

0.2.3

Fix consuming request body issue (https://github.com/haskell-servant/servant/issues/3)
Make code sample in Servant.Server complete