Metadata-Version: 1.1
Name: swagger-parser
Version: 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: GPL
Description: [![Build Status](https://travis-ci.org/Trax-air/swagger-parser.svg?branch=master)](https://travis-ci.org/Trax-air/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...
        
        Example Usage
        -------------
        
        ```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')
        ```
        
        Setup
        -----
        
        `make install`
        
        License
        -------
        
        swagger-parser is licensed under [GPL 3.0](http://opensource.org/licenses/GPL-3.0).
        
        
        =======
        History
        =======
        
        0.1 (2016-1-28)
        ------------------
        
        * First release on PyPI.
        
Keywords: swagger,parser,API,REST,swagger-parser
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
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
Classifier: Programming Language :: Python :: 3.5
