class Swagger::Builder

Overview

Swagger Builder

Defined in:

swagger/builder.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(title : String, version : String, description : String | Nil = nil, terms_url : String | Nil = nil, license : License | Nil = nil, contact : Contact | Nil = nil, authorizations : Array(Authorization) | Nil = nil) #

[View source]
def self.new(info : Info, authorizations : Array(Authorization) | Nil = nil) #

[View source]

Instance Method Detail

def <<(object : Object) #

[View source]
def <<(controller : Controller) #

[View source]
def <<(server : Server) #

[View source]
def add(object : Object) #

[View source]
def add(controller : Controller) #

[View source]
def add(server : Server) #

[View source]
def add(*, controller name : String, description : String, actions : Array(Action), external_docs : Objects::ExternalDocs | Nil = nil) #

[View source]
def add(*, server name : String, description : String | Nil = nil, variables : Array(Variable) | Nil = nil) #

[View source]
def build_security(security_schemes) #

[View source]
def build_security_schemes #

[View source]
def built #

[View source]
def controllers : Array(Swagger::Controller) #

[View source]
def controllers=(controllers : Array(Swagger::Controller)) #

[View source]

[View source]
def info=(info : Swagger::Objects::Info) #

[View source]
def objects : Array(Swagger::Object) #

[View source]
def objects=(objects : Array(Swagger::Object)) #

[View source]
def servers : Array(Swagger::Server) #

[View source]
def servers=(servers : Array(Swagger::Server)) #

[View source]