Module: Grape::DSL::Desc

Extended by:
Settings
Included in:
API::Instance
Defined in:
lib/grape/dsl/desc.rb

Instance Attribute Summary

Attributes included from Settings

#inheritable_setting

Instance Method Summary collapse

Methods included from Settings

global_setting, namespace_setting, route_setting, top_level_setting

Instance Method Details

#desc(description, *legacy_options, **options) { ... } ⇒ Object

Add a description to the next namespace or function.

Examples:


desc 'create a user'
post '/users' do
  # ...
end

desc 'find a user' do
  detail 'locates the user from the given user ID'
  failure [ [404, 'Couldn\'t find the given user' ] ]
  success User::Entity
end
get '/user/:id' do
  # ...
end

Parameters:

  • description (String) —

    descriptive string for this endpoint or namespace

  • options (Hash) —

    other properties you can set to describe the endpoint or namespace. Optional. Pass these as keyword arguments; passing a positional options Hash is deprecated.

Options Hash (**options):

  • :detail (String) —

    additional detail about this endpoint

  • :summary (String) —

    summary for this endpoint

  • :params (Hash) —

    param types and info. normally, you set these via the ‘params` dsl method.

  • :entity (Grape::Entity) —

    the entity returned upon a successful call to this action

  • :http_codes (Array[Array]) —

    possible HTTP codes this endpoint may return, with their meanings, in a 2d array

  • :named (String) —

    a specific name to help find this route

  • :body_name (String) —

    override the autogenerated body name param

  • :headers (Hash) —

    HTTP headers this method can accept

  • :hidden (Boolean) —

    hide the endpoint or not

  • :deprecated (Boolean) —

    deprecate the endpoint or not

  • :is_array (Boolean) —

    response entity is array or not

  • :nickname (String) —

    nickname of the endpoint

  • :produces (Array[String]) —

    a list of MIME types the endpoint produce

  • :consumes (Array[String]) —

    a list of MIME types the endpoint consume

  • :security (Array[Hash]) —

    a list of security schemes

  • :tags (Array[String]) —

    a list of tags

Yields:

  • a block yielding an instance context with methods mapping to each of the above, except that :entity is also aliased as #success and :http_codes is aliased as #failure.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/grape/dsl/desc.rb', line 53

def desc(description, *legacy_options, **options, &config_block)
  if legacy_options.any?
    Grape.deprecator.warn('Passing a positional options Hash to `desc` is deprecated. Pass keyword arguments instead.')
    options = legacy_options.first.merge(options)
  end

  settings =
    if config_block
      endpoint_config = defined?(configuration) ? configuration : nil
      Grape::Util::ApiDescription.new(description, endpoint_config, &config_block).settings
    else
      options.merge(description:)
    end
  inheritable_setting.namespace[:description] = settings
  inheritable_setting.route[:description] = settings
end