Data.Swagger.Build.Api

Construction of Data.Swagger.Model.Api values. For example:

declare "http://petstore.swagger.wordnik.com/api" "1.2" $ do
   apiVersion "1.0.0"
   resourcePath "/store"
   model foo
   model bar
   produces "application/json"
   produces "text/html"
   produces "text/plain"
   api "/store/order/{orderId}" $ do
       operation "GET" "foo" $ do
           summary "give me some foo"
           notes   "but only the good one"
           returns (ref foo)
           parameter Header "type" (string $ enum ["bar", "baz"]) $ do
               description "specifies the type of foo"
               optional
           parameter Query "format" (string $ enum ["plain", "html"]) $
               description "output format"
           parameter Query "size" (int32 $ min 1 . max 100 . def 10) $
               description "amount of foo"
           produces "application/json"
           produces "text/html"
           response 200 "OK" (model foo)
           response 400 "Bad Request" end
       operation "POST" "foo" $ do
           summary "something else"
           deprecated

data types

Re-exports

data ApiDecl

Cf. API Declaration

Instances

Show ApiDecl

Methods

showsPrec :: Int -> ApiDecl -> ShowS

show :: ApiDecl -> String

showList :: [ApiDecl] -> ShowS

ToJSON ApiDecl

Methods

toJSON :: ApiDecl -> Value

toEncoding :: ApiDecl -> Encoding

toJSONList :: [ApiDecl] -> Value

toEncodingList :: [ApiDecl] -> Encoding

data API

Cf. API Object

Instances

Show API

Methods

showsPrec :: Int -> API -> ShowS

show :: API -> String

showList :: [API] -> ShowS

ToJSON API

Methods

toJSON :: API -> Value

toEncoding :: API -> Encoding

toJSONList :: [API] -> Value

toEncodingList :: [API] -> Encoding

data Operation

Cf. Operation Object

Instances

Show Operation

Methods

showsPrec :: Int -> Operation -> ShowS

show :: Operation -> String

showList :: [Operation] -> ShowS

ToJSON Operation

Methods

toJSON :: Operation -> Value

toEncoding :: Operation -> Encoding

toJSONList :: [Operation] -> Value

toEncodingList :: [Operation] -> Encoding

data Parameter

Cf. Parameter Object

Instances

Show Parameter

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

ToJSON Parameter

Methods

toJSON :: Parameter -> Value

toEncoding :: Parameter -> Encoding

toJSONList :: [Parameter] -> Value

toEncodingList :: [Parameter] -> Encoding

data ParamType

Constructors

Path

Query

Body

Header

Form

Instances

Eq ParamType

Methods

(==) :: ParamType -> ParamType -> Bool

(/=) :: ParamType -> ParamType -> Bool

Show ParamType

Methods

showsPrec :: Int -> ParamType -> ShowS

show :: ParamType -> String

showList :: [ParamType] -> ShowS

ToJSON ParamType

Methods

toJSON :: ParamType -> Value

toEncoding :: ParamType -> Encoding

toJSONList :: [ParamType] -> Value

toEncodingList :: [ParamType] -> Encoding

data Response

Cf. Response Message Object

Instances

Show Response

Methods

showsPrec :: Int -> Response -> ShowS

show :: Response -> String

showList :: [Response] -> ShowS

ToJSON Response

Methods

toJSON :: Response -> Value

toEncoding :: Response -> Encoding

toJSONList :: [Response] -> Value

toEncodingList :: [Response] -> Encoding

data Model

Cf. Model Object

Instances

Show Model

Methods

showsPrec :: Int -> Model -> ShowS

show :: Model -> String

showList :: [Model] -> ShowS

ToJSON Model

Methods

toJSON :: Model -> Value

toEncoding :: Model -> Encoding

toJSONList :: [Model] -> Value

toEncodingList :: [Model] -> Encoding

data Property

Cf. Property Object

Instances

Show Property

Methods

showsPrec :: Int -> Property -> ShowS

show :: Property -> String

showList :: [Property] -> ShowS

ToJSON Property

Methods

toJSON :: Property -> Value

toEncoding :: Property -> Encoding

toJSONList :: [Property] -> Value

toEncodingList :: [Property] -> Encoding

data DataType

Instances

Show DataType

Methods

showsPrec :: Int -> DataType -> ShowS

show :: DataType -> String

showList :: [DataType] -> ShowS

data Primitive a

Cf. Primitive Types

Instances

Show a => Show (Primitive a)

Methods

showsPrec :: Int -> Primitive a -> ShowS

show :: Primitive a -> String

showList :: [Primitive a] -> ShowS

data Items a

Instances

Show a => Show (Items a)

Methods

showsPrec :: Int -> Items a -> ShowS

show :: Items a -> String

showList :: [Items a] -> ShowS

primitive construction

int32 :: (Primitive Int32 -> Primitive Int32) -> DataType

int32' :: DataType

int64 :: (Primitive Int64 -> Primitive Int64) -> DataType

int64' :: DataType

float :: (Primitive Float -> Primitive Float) -> DataType

float' :: DataType

bool :: (Primitive Bool -> Primitive Bool) -> DataType

bool' :: DataType

double :: (Primitive Double -> Primitive Double) -> DataType

double' :: DataType

string :: (Primitive String -> Primitive String) -> DataType

string' :: DataType

bytes :: (Primitive String -> Primitive String) -> DataType

bytes' :: DataType

date :: (Primitive UTCTime -> Primitive UTCTime) -> DataType

date' :: DataType

dateTime :: (Primitive UTCTime -> Primitive UTCTime) -> DataType

dateTime' :: DataType

primitive modifiers

def :: a -> Primitive a -> Primitive a

Default value of some primitive type.

enum :: [a] -> Primitive a -> Primitive a

Enumerate valid values of some primitive type.

min :: a -> Primitive a -> Primitive a

Minimum value of some primitive type.

max :: a -> Primitive a -> Primitive a

Maximum value of some primitive type.

data-type constructors

ref :: Model -> DataType

array :: DataType -> DataType

unique :: DataType -> DataType

Specify that array elements are unique.

builder types

type ApiDeclSt = Common '["produces", "consumes", "models", "authorisations"] ApiDecl

type ApiDeclBuilder = State ApiDeclSt ()

type ApiSt = Common '["description"] API

type ApiBuilder = State ApiSt ()

type OperationSt = Common '["produces", "consumes", "authorisations"] Operation

type OperationBuilder = State OperationSt ()

type ParameterSt = Common '["description", "required"] Parameter

type ParameterBuilder = State ParameterSt ()

type ResponseSt = Common '["models"] Response

type ResponseBuilder = State ResponseSt ()

type ModelSt = Common '["description"] Model

type ModelBuilder = State ModelSt ()

type PropertySt = Common '["description", "required"] Property

type PropertyBuilder = State PropertySt ()

API declaration

declare :: Text -> Text -> ApiDeclBuilder -> ApiDecl

Create an API declaration given a base URL, a swagger version, and other API declaration values.

apiVersion :: Text -> ApiDeclBuilder

resourcePath :: Text -> ApiDeclBuilder

api :: Text -> ApiBuilder -> ApiDeclBuilder

Add one API object to an API declaration given some path and other API object values.

model :: Elem "models" f => Model -> State (Common f a) ()

operation

operation :: Text -> Text -> OperationBuilder -> ApiBuilder

Add one operation object to an API object given an HTTP method, a nickname and other operation specific values.

returns :: DataType -> OperationBuilder

parameter :: ParamType -> Text -> DataType -> ParameterBuilder -> OperationBuilder

Add one parameter object to an operation object given the ParamType, the parameter name and the actual data-type plus some other parameter values.

file :: Text -> ParameterBuilder -> OperationBuilder

Like parameter but specific for file uploads.

body :: DataType -> ParameterBuilder -> OperationBuilder

Like parameter but specific for request body parameters. Sets ParamType to Body and uses as name "body" which is the only valid name for request bodies.

summary :: Text -> OperationBuilder

notes :: Text -> OperationBuilder

response :: Int -> Text -> ResponseBuilder -> OperationBuilder

Add one response message object to an operation given a status code and some message plus response message specific values.

produces :: Elem "produces" f => Text -> State (Common f a) ()

authorisation :: Elem "authorisations" f => Auth -> State (Common f a) ()

data Auth

Constructors

Basic

ApiKey

OAuth2 Scope

None

parameter

multiple :: ParameterBuilder

model

defineModel :: ModelId -> ModelBuilder -> Model

Construct a complex data-type (aka "Model") given some identifier and model-specific values.

property :: PropertyName -> DataType -> PropertyBuilder -> ModelBuilder

Add a property to a model given a name, type and other propertu values.

children :: PropertyName -> [Model] -> ModelBuilder

Specify a sub-typing relationship for a model by given a "discriminator" property name and all sub-types.

various

description :: Elem "description" f => Text -> State (Common f a) ()

optional :: Elem "required" f => State (Common f a) ()

consumes :: Elem "consumes" f => Text -> State (Common f a) ()

deprecated :: OperationBuilder

end :: Monad m => m ()

If cases where no build steps are provided but a builder is required end can be used, e.g. defineModel "Foo" end