Class: Committee::Drivers::OpenAPI2
- Defined in:
- lib/committee/drivers/open_api_2.rb
Defined Under Namespace
Classes: HeaderSchemaBuilder, Link, ParameterSchemaBuilder, Schema, SchemaBuilder
Instance Method Summary collapse
-
#default_coerce_form_params ⇒ Object
Whether parameters that were form-encoded will be coerced by default.
-
#default_path_params ⇒ Object
Whether parameters in a request’s path will be considered and coerced by default.
-
#default_query_params ⇒ Object
Whether parameters in a request’s query string will be considered and coerced by default.
- #name ⇒ Object
-
#parse(data) ⇒ Object
Parses an API schema and builds a set of route definitions for use with Committee.
- #schema_class ⇒ Object
Instance Method Details
#default_coerce_form_params ⇒ Object
Whether parameters that were form-encoded will be coerced by default.
4 5 6 |
# File 'lib/committee/drivers/open_api_2.rb', line 4 def default_coerce_form_params true end |
#default_path_params ⇒ Object
Whether parameters in a request’s path will be considered and coerced by default.
10 11 12 |
# File 'lib/committee/drivers/open_api_2.rb', line 10 def default_path_params true end |
#default_query_params ⇒ Object
Whether parameters in a request’s query string will be considered and coerced by default.
16 17 18 |
# File 'lib/committee/drivers/open_api_2.rb', line 16 def default_query_params true end |
#name ⇒ Object
20 21 22 |
# File 'lib/committee/drivers/open_api_2.rb', line 20 def name :open_api_2 end |
#parse(data) ⇒ Object
Parses an API schema and builds a set of route definitions for use with Committee.
The expected input format is a data hash with keys as strings (as opposed to symbols) like the kind produced by JSON.parse or YAML.load.
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/committee/drivers/open_api_2.rb', line 29 def parse(data) REQUIRED_FIELDS.each do |field| if !data[field] raise ArgumentError, "Committee: no #{field} section in spec data." end end if data['swagger'] != '2.0' raise ArgumentError, "Committee: driver requires OpenAPI 2.0." end schema = Schema.new schema.driver = self schema.base_path = data['basePath'] || '' # Arbitrarily choose the first media type found in these arrays. This # appraoch could probably stand to be improved, but at least users will # for now have the option of turning media type validation off if they so # choose. schema.consumes = data['consumes'].first schema.produces = data['produces'].first schema.definitions, store = parse_definitions!(data) schema.routes = parse_routes!(data, schema, store) schema end |