Skip to main content

Swagger parser giving useful informations about your swagger files

Project description

Travis status Join the chat at https://gitter.im/Trax-air/swagger-parser https://img.shields.io/pypi/v/swagger-parser.svg

swagger-parser

Swagger-parser is a python module giving you access to some interesting data about your swagger file. Like getting a dictionary example from a definition name, get the definition of a dictionary, and more.

Example Usage

from swagger_parser import SwaggerParser

parser = SwaggerParser(swagger_path='swagger_path')  # Init with file
parser = SwaggerParser(swagger_dict={})  # Init with dictionary

# Get an example of dict for the definition Foo
parser.definitions_example.get('Foo')

# Get the definition of a dictionary
test = {
  'foo': 'bar'
}
parser.get_dict_definition(test)

# Validate the definition of a dict
parser.validate_definition('Foo', test)

# Validate that the given data match a path specification
parser.validate_request('/foo', 'post', body=test, query={'foo': 'bar'})

# Get the possible return value of a path
# It will return a dictionary with keys as status_code
# and value as example of return value.
parser.get_request_data('/foo', 'post', body=test)

# Get an example of a correct body for a path
parser.get_send_request_correct_body('/foo', 'post')

Documentation

More documentation is available at https://swagger-parser.readthedocs.org/en/latest/.

Setup

make install or pip install swagger-parser

License

swagger-parser is licensed under http://opensource.org/licenses/MIT.

History

1.0.0 (2017-6-11)

0.1.11 (2016-9-25)

  • Support additionalProperties.

0.1.10 (2016-8-25)

  • Don’t choke if there are no definitions

  • Generate operations without operationId

  • Generate example from properties

0.1.9 (2016-7-28)

  • Support array definitions.

0.1.8 (2016-5-11)

  • Support type field to be an array.

  • Use base path to validate request.

0.1.7 (2016-4-1)

  • Support UTF-8 in swagger.yaml.

0.1.6 (2016-3-16)

  • Add support for path-level parameters.

0.1.5 (2016-2-17)

  • Add support for parameters references in path specs.

0.1.4 (2016-2-10)

  • Handle string as status_code.

0.1.3 (2016-2-3)

  • Fix a bug in get_response_example with schema only containing a type field.

0.1.2 (2016-2-3)

  • Support schema with only a type field.

0.1.1 (2016-1-31)

  • Change license to MIT.

0.1 (2016-1-28)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

swagger_parser-1.0.2.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

swagger_parser-1.0.2-py2.py3-none-any.whl (13.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file swagger_parser-1.0.2.tar.gz.

File metadata

  • Download URL: swagger_parser-1.0.2.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0.post20201221 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.6.7

File hashes

Hashes for swagger_parser-1.0.2.tar.gz
Algorithm Hash digest
SHA256 9b37c3e23bdadc90716f4b0bae0e7943c1900ae2aed7735b228d65a6485cd17b
MD5 db2f010dcb3635ae816641bd95633ae1
BLAKE2b-256 9e46b7212e55c01cfc950d50a975858ee04193f796ad3e9911dfebc83848949a

See more details on using hashes here.

File details

Details for the file swagger_parser-1.0.2-py2.py3-none-any.whl.

File metadata

  • Download URL: swagger_parser-1.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0.post20201221 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.6.7

File hashes

Hashes for swagger_parser-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 251b5f9c54932ec140ba340afac66d75a72f8ed9185c4d35750949d689ec5860
MD5 f002c2ce96bdae75af2d714ac82d86a0
BLAKE2b-256 3b46eb9c040886178ba2cfaa19bf6e7daa238cfaeffa48cf6b6c20173a24301b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page