Sha256: d12ad6eede86f31141d304a307f593b950ae0c6bf6bcd341800f5bdd2276040a
Contents?: true
Size: 1.41 KB
Versions: 15
Compression:
Stored size: 1.41 KB
Contents
require 'rspec_api_docs'
require 'rspec_api_docs/dsl/request_store'
require 'rspec_api_docs/dsl/doc_proxy'
module RspecApiDocs
# This module is intended to be included in your RSpec specs to expose the
# {#doc} method.
module Dsl
# 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
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
def example
RSpec.current_example
end
end
end
Version data entries
15 entries across 15 versions & 1 rubygems