class Swagger

• Swagger
• Reference
• Object

Included Modules

• JSON::Serializable
• YAML::Serializable

Defined in:

swagger.cr
swagger/header.cr
swagger/info.cr
swagger/operation.cr
swagger/parameter.cr
swagger/path_item.cr
swagger/reference.cr
swagger/response.cr
swagger/schema.cr
swagger/tag.cr

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)

Class Method Summary

• .from_file(path : Path | String)

Instance Method Summary

• #basePath : String
• #basePath=(basePath : String)
• #consumes : Array(String) | Nil
• #consumes=(consumes : Array(String) | Nil)
• #definitions : Hash(String, Schema)
• #definitions=(definitions : Hash(String, Schema))
• #find(ref : String) : Schema | Parameter | Response
• #find?(ref : String) : Schema | Parameter | Response | Nil
• #info : Info
• #info=(info : Info)
• #parameters : Hash(String, Parameter)
• #parameters=(parameters : Hash(String, Parameter))
• #paths : Hash(String, PathItem)

  property securityDefinitions : Hash(String, SecurityScheme)

• #paths=(paths : Hash(String, PathItem))

  property securityDefinitions : Hash(String, SecurityScheme)

• #produces : Array(String) | Nil
• #produces=(produces : Array(String) | Nil)
• #responses : Hash(String, Response)
• #responses=(responses : Hash(String, Response))
• #swagger : String
• #swagger=(swagger : String)
• #tags : Array(Tag) | Nil
• #tags=(tags : Array(Tag) | Nil)

Constructor Detail

Class Method Detail

Instance Method Detail