http-media

Processing HTTP Content-Type and Accept headers

Version on this page:	0.6.4
LTS Haskell 22.36:	0.8.1.1@rev:2
Stackage Nightly 2024-10-05:	0.8.1.1@rev:2
Latest on Hackage:	0.8.1.1@rev:2

See all snapshots http-media appears in

MIT licensed by Timothy Jones

Maintained by Timothy Jones

This version can be pinned in stack with:http-media-0.6.4@sha256:71ba69497a15213b031fb12437803a5dbfbb549ac05a080df9e125ec4d9eecc6,3568

Module documentation for 0.6.4

Network
- Network.HTTP
  - Network.HTTP.Media

Depends on 4 packages(full list with versions):

base, bytestring, case-insensitive, containers

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

airship, gogol, gogol-core, magicbane, servant, servant-blaze, servant-cassava, servant-checked-exceptions, servant-client, servant-docs, servant-JuicyPixels, servant-lucid, servant-static-th, servant-swagger, servant-swagger-ui, servant-yaml, swagger2, wai-middleware-content-type

This library is intended to be a comprehensive solution to parsing and selecting quality-indexed values in HTTP headers. It is capable of parsing both media types and language parameters from the Accept and Content header families, and can be extended to match against other accept headers as well. Selecting the appropriate header value is achieved by comparing a list of server options against the quality-indexed values supplied by the client.

In the following example, the Accept header is parsed and then matched against a list of server options to serve the appropriate media using mapAcceptMedia:

getHeader >>= maybe send406Error sendResourceWith . mapAcceptMedia
    [ ("text/html",        asHtml)
    , ("application/json", asJson)
    ]

Similarly, the Content-Type header can be used to produce a parser for request bodies based on the given content type with mapContentMedia:

getContentType >>= maybe send415Error readRequestBodyWith . mapContentMedia
    [ ("application/json", parseJson)
    , ("text/plain",       parseText)
    ]

The API is agnostic to your choice of server.