Module: GrapeOAS::ApiModelBuilders::ResponseParsers::Base

Included in:

DefaultResponseParser, DocumentationResponsesParser, HttpCodesParser

Defined in:

lib/grape_oas/api_model_builders/response_parsers/base.rb

Overview

Base module for response parser strategies Each parser is responsible for extracting response specifications from a specific format (e.g., :http_codes, documentation: { responses: … })

Instance Method Summary

• #applicable?(route) ⇒ Boolean

  Check if this parser can handle the given route.

• #parse(route) ⇒ Array<Hash>

  Parse response specifications from the route.

Instance Method Details

#applicable?(route) ⇒ Boolean

Check if this parser can handle the given route

Parameters:

• route (Grape::Route) —

  The route to check

Returns:

• (Boolean) —

  true if this parser can parse the route

Raises:

• (NotImplementedError)

# File 'lib/grape_oas/api_model_builders/response_parsers/base.rb', line 26

def applicable?(route)
  raise NotImplementedError, "#{self.class} must implement #applicable?"
end

#parse(route) ⇒ Array<Hash>

Parse response specifications from the route

Parameters:

• route (Grape::Route) —

  The route to parse

Returns:

• (Array<Hash>) —

  Array of normalized response specs with keys:

  • code: HTTP status code

  • message: Response description

  • entity: Entity class for response schema

  • headers: Response headers

  • extensions: Custom x- extensions (optional)

  • examples: Response examples (optional)

Raises:

• (NotImplementedError)

# File 'lib/grape_oas/api_model_builders/response_parsers/base.rb', line 19

def parse(route)
  raise NotImplementedError, "#{self.class} must implement #parse"
end