Skip to content

Latest commit

 

History

History
61 lines (52 loc) · 4.42 KB

config.rst

File metadata and controls

61 lines (52 loc) · 4.42 KB

Configuration

All configuration is stored in a dict.

from bravado_core.spec import Spec

spec_dict = json.loads(open('swagger.json', 'r').read())

config = {
    'validate_requests': False,
    'use_models': False,
}

swagger_spec = Spec.from_dict(spec_dict, config=config)
Config key Type Default Description

validate_swagger_spec

boolean

True

Validate the Swagger spec against
the Swagger 2.0 Specification.
----------------------------- --------------- --------- ----------------------------------------------------

validate_requests

boolean

True

On the client side, validates outgoing requests.
On the server side, validates incoming requests.
----------------------------- --------------- --------- ----------------------------------------------------

validate_responses

boolean

True

On the client side, validates incoming responses.
On the server side, validates outgoing responses.
----------------------------- --------------- --------- ----------------------------------------------------

use_models

boolean

True

Use python classes to represent models
instead of dicts. See models.
----------------------------- --------------- --------- ----------------------------------------------------

formats

list of SwaggerFormat

[]

List of user-defined formats to support.
See formats.
----------------------------- --------------- --------- ----------------------------------------------------

include_missing_properties

boolean

True

Create properties with the value None if they
were not submitted during object unmarshalling
----------------------------- --------------- --------- ----------------------------------------------------

default_type_to_object

boolean

False

When set to True, missing types will default
to object and be validated as such.
When set to False, missing types will not be
validated at all.
----------------------------- --------------- --------- ----------------------------------------------------

internally_dereference_refs

boolean

False

Completely dereference $refs to maximize
marshalling and unmarshalling performance.
NOTE: this depends on validate_swagger_spec
----------------------------- --------------- --------- ----------------------------------------------------

use_spec_url_for_base_path

boolean

False

What value to assume for basePath if it is missing
from the spec (this config option is ignored if
basePath is present in the spec).
If enabled, use the path element of the URL the
spec was retrieved from.
If disabled, set basePath to / (conforms to
the Swagger 2.0 specification)
----------------------------- --------------- --------- ----------------------------------------------------

use_base64_for_byte_format

boolean

False

If true, base64-encode binary data to wire and
base64-decode from wire for data with byte format.