phoenix_swagger v0.1.0 PhoenixSwagger.Path
Defines the swagger path DSL for specifying Controller actions. This module should not be imported directly, it will be automatically imported in the scope of a swagger_path macro body.
Examples
use PhoenixSwagger
swagger_path :index do
get "/users"
produces "application/json"
paging
parameter :id, :query, :integer, "user id", required: true
tag "Users"
response 200 "User resource" :User
response 404 "User not found"
end
Summary
Functions
Adds a mime-type to the consumes list of the operation of a swagger %PathObject{}
Initializes a Swagger Path DSL block with a delete verb
Adds the description section to the operation of a swagger %PathObject{}
Initializes a Swagger Path DSL block with a get verb
Initializes a Swagger Path DSL block with a head verb
Converts the %PathObject{} struct into the nested JSON form expected by swagger
Adds the operationId section to the operation of a swagger %PathObject{}
Initializes a Swagger Path DSL block with a options verb
Adds page size and page number parameters to the operation of a swagger %PathObject{}
Adds a parameter to the operation of a swagger %PathObject{}
Initializes a Swagger Path DSL block with a post verb
Adds a mime-type to the produces list of the operation of a swagger %PathObject{}
Initializes a Swagger Path DSL block with a put verb
Adds a response to the operation of a swagger %PathObject{}, without a schema
Adds a parameter to the operation of a swagger %PathObject{}, with a schema
Adds the summary section to the operation of a swagger %PathObject{}
Adds a tag to the operation of a swagger %PathObject{}
Functions
Adds a mime-type to the consumes list of the operation of a swagger %PathObject{}
Adds the description section to the operation of a swagger %PathObject{}
Adds the operationId section to the operation of a swagger %PathObject{}
Adds page size and page number parameters to the operation of a swagger %PathObject{}
The names default to “page[size]“ and “page[number]“, but can be overridden.
Adds a parameter to the operation of a swagger %PathObject{}
Adds a mime-type to the produces list of the operation of a swagger %PathObject{}
Adds a response to the operation of a swagger %PathObject{}, without a schema
Adds a parameter to the operation of a swagger %PathObject{}, with a schema