http-api-data

Converting to/from HTTP API data like URL pieces, headers and query parameters.

http://github.com/fizruk/http-api-data

Version on this page:0.3.6
LTS Haskell 23.22:0.6.2
Stackage Nightly 2025-05-16:0.6.2
Latest on Hackage:0.6.2

See all snapshots http-api-data appears in

BSD-3-Clause licensed and maintained by Nickolay Kudasov
This version can be pinned in stack with:http-api-data-0.3.6@sha256:4aee1329127f660fdeb379b597bce335e88173c6ffec7e9b3d83c07e2afbcb23,2818

Module documentation for 0.3.6

http-api-data

Build Status Hackage package Stackage LTS Stackage Nightly

This package defines typeclasses used for converting Haskell data types to and from HTTP API data.

Examples

Booleans:

>>> toUrlPiece True
"true"
>>> parseUrlPiece "false" :: Either Text Bool
Right False
>>> parseUrlPieces ["true", "false", "undefined"] :: Either Text [Bool]
Left "could not parse: `undefined'"

Numbers:

>>> toQueryParam 45.2
"45.2"
>>> parseQueryParam "452" :: Either Text Int
Right 452
>>> toQueryParams [1..5]
["1","2","3","4","5"]
>>> parseQueryParams ["127", "255"] :: Either Text [Int8]
Left "out of bounds: `255' (should be between -128 and 127)"

Strings:

>>> toHeader "hello"
"hello"
>>> parseHeader "world" :: Either Text String
Right "world"

Calendar day:

>>> toQueryParam (fromGregorian 2015 10 03)
"2015-10-03"
>>> toGregorian <$> parseQueryParam "2016-12-01"
Right (2016,12,1)

Contributing

Contributions and bug reports are welcome!

Changes

0.3.6

  • Minor change:
    • Add toEncodedUrlPiece class method for URL-encoded path segments (see #50); use efficient encoding for types whose values don’t need URL-encoding.

0.3.5

  • Minor changes:
    • Add LenientData which always succeeds to parse (see #45).

0.3.4

  • Minor changes:
    • Add support for GHC 8.2, drop support for GHC 7.6 (see #44).

0.3.3

  • Minor changes:
    • Expose Form constructor from Web.FromUrlEncoded (see #40);
    • Fix example in FromForm documentation (see #39).

0.3.2

  • Minor change:
    • Export Form type from Web.FormUrlEncoded (see #37).

0.3.1

  • Minor changes:
    • Add instances for Data.UUID (see #34).

0.3

  • Major changes:

    • Add Web.FormUrlEncoded to work with form data (see #32).

  • Minor changes:

    • Add instances for Numeric.Natural (see d944721).

0.2.4

  • Make parseHeader total (instead of throwing exceptions on invalid Unicode, see #30).

0.2.3

  • Add more parser helpers for Bounded Enum types.

0.2.2

  • Add instances for more time types: LocalTime, ZonedTime, UTCTime and NominalDiffTime

0.2.1

  • Add helpers for multiple URL pieces and query params:
    • toUrlPieces, parseUrlPieces
    • toQueryParams, parseQueryParams

0.2

  • Export helper functions from Web.HttpApiData:
    • parseUrlPieceMaybe, parseHeaderMaybe, parseQueryParamMaybe
    • parseUrlPieceWithPrefix, parseHeaderWithPrefix, parseQueryParamWithPrefix
    • showTextData, readTextData, parseBoundedTextData
  • Fix AMP related warnings

0.1.1

  • Add use-text-show flag to optionally use more efficient TextShow instances