Metadata-Version: 1.1
Name: swagger-parser
Version: 1.0.1
Summary: Swagger parser giving useful informations about your swagger files
Home-page: https://github.com/Trax-air/swagger-parser
Author: Cyprien Guillemot
Author-email: cyprien.guillemot@gmail.com
License: MIT
Description: .. image:: https://travis-ci.org/Trax-air/swagger-parser.svg?branch=master
           :alt: Travis status
           :target: https://travis-ci.org/Trax-air/swagger-parser 
        .. image:: https://badges.gitter.im/Trax-air/swagger-parser.svg
           :alt: Join the chat at https://gitter.im/Trax-air/swagger-parser
           :target: https://gitter.im/Trax-air/swagger-parser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
        .. image:: https://img.shields.io/pypi/v/swagger-parser.svg
            :target: https://pypi.python.org/pypi/swagger-parser/
        
        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.
        
        Related Libraries
        -----------------
        You may find related libraries to this one:
        
        * https://github.com/Trax-air/swagger-tester: Auto-test your swagger API in your unit tests. All test calls are generated by your swagger file.
        * https://github.com/Trax-air/swagger-stub: A stub you can use in your client's unit tests. All the HTTP calls to your swagger API are mocked by default. You can also add your own mocked_calls in your test functions.
        * https://github.com/Trax-air/swagger-aggregator: Aggregate several swagger specs into one. Useful for your API gateways!
        
        Example Usage
        -------------
        
        .. code:: python
        
          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)
        -----------------
        
        * Drop support for python 2.6, add support for python 3.5, python 3.6 and pypy
        * Fix issue `#35 <https://github.com/Trax-air/swagger-parser/issues/35>`_
        * `Add file parser tests and fixes for #40, #41, #42, #43, #44, #45 <https://github.com/Trax-air/swagger-parser/pull/39>`_, thanks to @mtherieau
        * `Use isinstance for simple type checking <https://github.com/Trax-air/swagger-parser/pull/36>`_, thanks to @pankaj28843
        * `Fixes for #31, #32, #33 <https://github.com/Trax-air/swagger-parser/pull/34>`_, thanks to @crudo10 and @beanqueen for the review
        * `Bug fix when dictionary only contains 1 element <https://github.com/Trax-air/swagger-parser/pull/30>`_, thanks to @TenOs
        * `Add tests for "official" petstore json and yaml <https://github.com/Trax-air/swagger-parser/pull/29>`_, 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.
        
Keywords: swagger,parser,API,REST,swagger-parser
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
