Skip to content
Automatically test your swagger API
Branch: master
Clone or download
Latest commit ef419b4 May 21, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
swagger_tester Bump version: 0.2.7 → 0.2.8 May 20, 2018
tests Fix flake 8 issue Oct 14, 2017
.checkignore Update .checkignore Feb 5, 2016
.editorconfig
.gitignore
.travis.yml
AUTHORS.rst
CONTRIBUTING.rst Fix docs Jan 29, 2016
HISTORY.rst DOC: Update HISTORY Nov 22, 2016
LICENSE Change license to MIT Jan 31, 2016
MANIFEST.in
Makefile Fix Makefile directories Jan 29, 2016
README.rst Remove broken/useless metrics on README Sep 11, 2016
requirements.txt use latest request version Sep 27, 2016
requirements_dev.txt BLD: Fixed version issues Feb 9, 2016
setup.cfg
setup.py Bump version: 0.2.7 → 0.2.8 May 20, 2018
tox.ini Remove python 3.3 and 2.6 as connexion is not compatible with it Jan 29, 2016
travis_pypi_setup.py

README.rst

Travis status Join the chat at https://gitter.im/Trax-air/swagger-tester

swagger-tester

Swagger-tester will test automatically your swagger API. Swagger API made with connexion (https://github.com/zalando/connexion) are supported directly without running the API server. In the case you use connexion it will automatically run a test server from your swagger file.

To run the test, swagger-tester will detect every path and actions of your API. And for each, it will send a request and check if the response match the swagger file specification.

Related Libraries

You may find related libraries to this one:

Example Usage

from swagger_tester import swagger_test

 # Dict containing the error you don't want to raise.
 # By default, every status_code over other than 1xx, 2xx or 3xx
 # will be considered as an error.
 authorize_error = {
       'post': {
           '/pet/{petId}': [200],
           '/pet': [200]
       },
       'put': {
           '/user/{username}': [200],
           '/pet': [200]
       },
       'delete': {
           '/pet/{petId}': [200],
           '/store/order/{orderId}': [200],
           '/user/{username}': [200]
       }
   }

 # Run the test with connexion
 # An AssertionError will be raise in case of error.
 swagger_test('path_to_your_swagger.yaml', authorize_error=authorize_error)

 # Or if you have a running API
 swagger_test(app_url='http://petstore.swagger.io/v2', authorize_error=authorize_error)

Documentation

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

Setup

make install or pip install swagger-tester

License

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

You can’t perform that action at this time.