class

App::Welcome

Inherits App::Base < App::Pagination < ActionController::Base < ActionController::Responders < ActionController::Route::Builder < Reference < Object

description of the welcome klass

Constants

OPENAPI = YAML.parse(File.exists?("openapi.yml") ? File.read("openapi.yml") : "{}")

this file is built as part of the docker build

PARSER_LIST = ["application/json"]

description of the welcome klass

RESPONDER_LIST = ["application/json", "text/html"]

description of the welcome klass

Class methods

base_route

Helper for obtaining base route

index(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts)

Helper methods for performing redirect_to calls

Instance methods

api(example : Int32) : NamedTuple(result: Int32)

For API applications the return value of the function is expected to work with all of the responder blocks (see application.cr) the various responses are returned based on the Accepts header

Source
base_route(*args, **options)

Helper for obtaining base route

base_route(*args, **options, &)

Helper for obtaining base route

index

A welcome message

Source
openapi

returns the OpenAPI representation of this service

Source