Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Wai.Middleware.ProblemDetails

Description

Middleware for WAI that implements the problem details RFC specified in https://www.rfc-editor.org/rfc/rfc7807.

Example:

{-# LANGUAGE OverloadedStrings #-}

module Main where

import Network.Wai.Handler.Warp (run)
import Data.Default
import Network.Wai.Middleware.ProblemDetails

main :: IO ()
main = run 8080 $ problemDetails $ app
  where
    app request respond = throwProblemDetails def

See the project's README and tests for more examples.

Synopsis

data ProblemDetails
setType :: URI -> ProblemDetails -> ProblemDetails
setTitle :: Text -> ProblemDetails -> ProblemDetails
title :: ProblemDetails -> Maybe Text
setDetail :: Text -> ProblemDetails -> ProblemDetails
setInstance :: URI -> ProblemDetails -> ProblemDetails
setExtensions :: Value -> ProblemDetails -> ProblemDetails
setStatus :: Int -> ProblemDetails -> ProblemDetails
status :: ProblemDetails -> Maybe Int
newtype ProblemDetailsException = ProblemDetailsException ProblemDetails
throwProblemDetails :: ProblemDetails -> a
throwProblemDetailsIO :: ProblemDetails -> IO a
problemDetails400 :: ProblemDetails
problemDetails401 :: ProblemDetails
problemDetails403 :: ProblemDetails
problemDetails404 :: ProblemDetails
problemDetails409 :: ProblemDetails
problemDetails :: Middleware

Documentation

data ProblemDetails Source #

The problem details data type.

Instances

Instances details

ToJSON ProblemDetails Source #
Instance details Defined in Network.Wai.Middleware.ProblemDetails.Internal.Types Methods toJSON :: ProblemDetails -> Value # toEncoding :: ProblemDetails -> Encoding # toJSONList :: [ProblemDetails] -> Value # toEncodingList :: [ProblemDetails] -> Encoding #
Generic ProblemDetails Source #
Instance details Defined in Network.Wai.Middleware.ProblemDetails.Internal.Types Associated Types type Rep ProblemDetails :: Type -> Type # Methods from :: ProblemDetails -> Rep ProblemDetails x # to :: Rep ProblemDetails x -> ProblemDetails #
Show ProblemDetails Source #
Instance details Defined in Network.Wai.Middleware.ProblemDetails.Internal.Types Methods showsPrec :: Int -> ProblemDetails -> ShowS # show :: ProblemDetails -> String # showList :: [ProblemDetails] -> ShowS #
Default ProblemDetails Source #
Instance details Defined in Network.Wai.Middleware.ProblemDetails.Internal.Types Methods def :: ProblemDetails #
type Rep ProblemDetails Source #
Instance details Defined in Network.Wai.Middleware.ProblemDetails.Internal.Types type Rep ProblemDetails = D1 ('MetaData "ProblemDetails" "Network.Wai.Middleware.ProblemDetails.Internal.Types" "wai-problem-details-0.1.1.0-7KTz629N8OeJtVEh92E1wM" 'False) (C1 ('MetaCons "ProblemDetails" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pdType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pdTitle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pdStatus") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "pdDetail") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pdInstance") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pdExtensions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Value))))))

setType :: URI -> ProblemDetails -> ProblemDetails Source #

setType sets the type field of the problem details object.

setTitle :: Text -> ProblemDetails -> ProblemDetails Source #

setTitle sets the title field of the problem details object.

title :: ProblemDetails -> Maybe Text Source #

title return the title for this ProblemDetails

setDetail :: Text -> ProblemDetails -> ProblemDetails Source #

setDetail sets the detail field of the problem details object.

setInstance :: URI -> ProblemDetails -> ProblemDetails Source #

setInstance sets the instance field of the problem details object.

setExtensions :: Value -> ProblemDetails -> ProblemDetails Source #

setExtensions adds the provided extensions to the problem details object.

setStatus :: Int -> ProblemDetails -> ProblemDetails Source #

setStatus sets the status field of the problem details object.

status :: ProblemDetails -> Maybe Int Source #

status return the status for this ProblemDetails

newtype ProblemDetailsException Source #

The exception that can be thrown from WAI applications when using the problem details middleware to send a problem details response.

Constructors

ProblemDetailsException ProblemDetails

Instances

Instances details

Exception ProblemDetailsException Source #
Instance details Defined in Network.Wai.Middleware.ProblemDetails.Internal.Exception Methods toException :: ProblemDetailsException -> SomeException # fromException :: SomeException -> Maybe ProblemDetailsException # displayException :: ProblemDetailsException -> String #
Show ProblemDetailsException Source #
Instance details Defined in Network.Wai.Middleware.ProblemDetails.Internal.Exception Methods showsPrec :: Int -> ProblemDetailsException -> ShowS # show :: ProblemDetailsException -> String # showList :: [ProblemDetailsException] -> ShowS #

throwProblemDetails :: ProblemDetails -> a Source #

Throw a ProblemDetailsException from a pure context.

throwProblemDetailsIO :: ProblemDetails -> IO a Source #

Throw a ProblemDetailsException from an IO context.

problemDetails400 :: ProblemDetails Source #

problemDetails401 :: ProblemDetails Source #

problemDetails403 :: ProblemDetails Source #

problemDetails404 :: ProblemDetails Source #

problemDetails409 :: ProblemDetails Source #

problemDetails :: Middleware Source #

Middleware that sends a problem+json response when an exception of type ProblemDetailsException is thrown from a WAI application.