struct Koa

• Koa
• Struct
• Value
• Object

Defined in:

koa.cr
koa/global.cr
koa/route.cr

Constructors

• .new

Class Method Summary

• .array(name : String, type : String, *, desc : String | Nil = nil)

  Defines an array schema

• .auth(key : String)

  Adds a registered authentication method to the succeeding route.

• .auth(keys : Array(String))

  Sets the list of authentication methods of the succeeding route.

• .basic_auth(key : String)

  Adds a Basic authentication method.

• .bearer_auth(key : String, format : String)

  Adds a Bearer authentication method.

• .binary(name : String, *, desc : String | Nil = nil)

  Defines a binary schema

• .body(*, type = "application/json", required = true, desc : String | Nil = nil, ref : String | Nil = nil)

  Specifies the required request body of the succeeding route.

• .cookie(name : String, *, desc : String | Nil = nil, required = true, type : String = "string", low_priority = false)

  Adds a cookie parameter to the succeeding route.

• .cookie_auth(key : String, name : String)

  Adds a API Key authentication method.

• .delete(path : String)

  Registers a delete route.

• .describe(summary : String, desc : String | Nil = nil)

  Sets summary and description (optional) of the succeeding route.

• .generate : OpenAPI::Document | Nil

  Generates an instance of OpenAPI::Document that contains the API specification.

• .get(path : String)

  Registers a get route.

• .global_tag(name : String, *, desc : String | Nil = nil)
• .header(name : String, *, desc : String | Nil = nil, required = true, type : String = "string", low_priority = false)

  Adds a header parameter to the succeeding route.

• .init(title : String, *, desc : String | Nil = nil, version = "1.0.0")

  Initializes Koa and sets the Info object of the API.

• .object(name : String, schema : Hash(String, String), *, desc : String | Nil = nil)

  Defines an object schema

• .options(path : String)

  Registers a options route.

• .patch(path : String)

  Registers a patch route.

• .path(name : String, *, desc : String | Nil = nil, required = true, type : String = "string", low_priority = false)

  Adds a path parameter to the succeeding route.

• .post(path : String)

  Registers a post route.

• .put(path : String)

  Registers a put route.

• .query(name : String, *, desc : String | Nil = nil, required = true, type : String = "string", low_priority = false)

  Adds a query parameter to the succeeding route.

• .response(status : UInt32, desc : String = "OK", *, ref : String | Nil = nil, media_type = "application/json")

  Adds a response to the succeeding route.

• .server(url : String, desc : String | Nil = nil)

  Adds a server to the server list.

• .tag(tag : String)

  Adds a tag to the succeeding route.

• .tags(tags : Array(String))

  Sets the tags of the succeeding route.

Instance Method Summary

• #initialize

Constructor Detail

Class Method Detail

Instance Method Detail