annotation OpenAPI::Generator::Controller::OpenAPI

Overview

This annotation is used to register a controller method as an OpenAPI Operation Object.

The argument must be a valid YAML representation of an OpenAPI operation object.

@[OpenAPI(<<-YAML
  tags:
  - tag
  summary: A brief summary of the method.
  responses:
    200:
      description: Ok.
YAML
)]
def method
end

Defined in:

openapi-generator/controller.cr