Swagger parser giving useful informations about your swagger files
Project description
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
1.0.0 (2017-6-11)
- Drop support for python 2.6, add support for python 3.5, python 3.6 and pypy
- Fix issue #35
- Add file parser tests and fixes for #40, #41, #42, #43, #44, #45, thanks to @mtherieau
- Use isinstance for simple type checking, thanks to @pankaj28843
- Fixes for #31, #32, #33, thanks to @crudo10 and @beanqueen for the review
- Bug fix when dictionary only contains 1 element, thanks to @TenOs
- Add tests for “official” petstore json and yaml, thanks to @beanqueen
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
Release history Release notifications | RSS feed
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 hashes)
Built Distribution
Close
Hashes for swagger_parser-1.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 251b5f9c54932ec140ba340afac66d75a72f8ed9185c4d35750949d689ec5860 |
|
MD5 | f002c2ce96bdae75af2d714ac82d86a0 |
|
BLAKE2-256 | 3b46eb9c040886178ba2cfaa19bf6e7daa238cfaeffa48cf6b6c20173a24301b |