servant-server

A family of combinators for defining webservices APIs and serving them

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

Version on this page:0.8.1
LTS Haskell 20.23:0.19.2@rev:2
Stackage Nightly 2023-05-31: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.8.1@sha256:04f76a33facd666ac6466090efe8cdc50ae55cb9833fd0795fa7ddcba726414e,4577

Module documentation for 0.8.1

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

0.7.1

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

0.2.4

0.2.3

A service provided by FP Complete