BlueBird v0.4.0 API Reference
Modules
Defines the ApiDoc
struct
Logs connections in test cases
Defines macros used to add documentation to api routes
Catches the :suite_finished
event fired by ExUnit
and triggers the
generation of the api blueprint file
Generates a map containing information about the api routes
A protocol for request and response attributes
Defines the Parameter
struct
Defines the Request
struct
Defines the Response
struct
Defines the Route
struct
Writes api documentations in apib and swagger format to files
Defines functions to generate an API BluePrint representation of the
BlueBird.ApiDoc
struct
Defines functions to convert BlueBird.ApiDoc
struct into a Swagger json
string
Mix Tasks
Generates HTML API Docs from api.apib using aglio
Renders the example tests as apib or swagger files