Module cowboy_swagger

cowboy-swagger main interface.

Description

cowboy-swagger main interface.

Data Types

metadata()

metadata() = trails:metadata(swagger_map())

parameter_definition_name()

parameter_definition_name() = binary()

parameter_obj()

abstract datatype: parameter_obj()

parameters_definition_array()

parameters_definition_array() = #{parameter_definition_name() => #{type => binary(), items => #{type => binary(), properties => property_obj()}}}

parameters_definitions()

parameters_definitions() = #{parameter_definition_name() => #{type => binary(), properties => property_obj()}}

property_desc()

property_desc() = #{type => binary(), description => binary(), example => binary(), items => property_desc()}

property_obj()

property_obj() = #{binary() => property_desc()}

response_obj()

abstract datatype: response_obj()

responses_definitions()

responses_definitions() = #{binary() => response_obj()}

swagger_map()

abstract datatype: swagger_map()

swagger_version()

swagger_version() = swagger_2_0 | openapi_3_0_0

Function Index

add_definition/1
add_definition/2
add_definition_array/2
get_existing_definitions/2
schema/1
to_json/1Returns the swagger json specification from given trails.

Function Details

add_definition/1

add_definition(Definition::parameters_definitions() | parameters_definition_array()) -> ok

add_definition/2

add_definition(Name::parameter_definition_name(), Properties::property_obj()) -> ok

add_definition_array/2

add_definition_array(Name::parameter_definition_name(), Properties::property_obj()) -> ok

get_existing_definitions/2

get_existing_definitions(CurrentSpec::map(), Type::scheams | parameters) -> Definition::parameters_definitions() | parameters_definition_array()

schema/1

schema(DefinitionName::parameter_definition_name()) -> map()

to_json/1

to_json(Trails::[trails:trail()]) -> jsx:json_text()

Returns the swagger json specification from given trails. This function basically takes the metadata from each trails:trail() (which must be compliant with Swagger specification) and builds the required swagger.json.


Generated by EDoc