module RspecApiDocs::Dsl
This module is intended to be included in your RSpec specs to expose the {#doc} method.
Public Instance Methods
doc(should_document = true, &block)
click to toggle source
DSL method for use in your RSpec examples.
Usage:
it 'returns a character' do doc do title 'Returns a Character' description 'Allows you to return a single character.' path '/characters/:id' param :id, 'The id of a character', required: true field :id, 'The id of a character', scope: :character field :name, "The character's name", scope: :character end get '/characters/1' end
For more info on the methods available in the block, see {DocProxy}.
@param should_document [true, false] clear documentation metadata for the example @return [RequestStore, nil] an object to store request/response pairs
# File lib/rspec_api_docs/dsl.rb, line 32 def doc(should_document = true, &block) if should_document example.metadata[METADATA_NAMESPACE] ||= {} if block DocProxy.new(example).instance_eval(&block) end RequestStore.new(example) else example.metadata[METADATA_NAMESPACE] = nil end end
Private Instance Methods
example()
click to toggle source
# File lib/rspec_api_docs/dsl.rb, line 48 def example RSpec.current_example end