Safe Haskell | None |
---|---|
Language | Haskell2010 |
Parse Servant API into documentation
Example script
Generating the intermediate documentation structure
Example of parsing an API
API type
type API = "hello" :> "world" :> Request :> Response type Request = ReqBody '[()] () type Response = Post '[()] ()
Intermediate structure
Endpoints [Node "/hello/world" (Details [ Node "RequestBody" (Details [ Node "Format" (Detail "': * () ('[] *)") , Node "ContentType" (Detail "()") ]) , Node "RequestType" (Detail "'POST") , Node "Response" (Details [ Node "Format" (Detail "': * () ('[] *)") , Node "ContentType" (Detail "()") ]) ])]
Synopsis
- class HasParsable api where
Documentation
class HasParsable api where Source #
Flattens API into type level list of Endpoints
Instances
HasCollatable (Endpoints a) => HasParsable (a :: Type) Source # | |
Defined in Servant.Docs.Simple.Parse | |
HasParsable EmptyAPI Source # | |
Defined in Servant.Docs.Simple.Parse |