Automatically test your swagger API
Project description
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.
Example Usage
from swagger_tester import swagger_test
# Define the error you authorize in your API
# 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.
History
0.2.6 (2016-5-20)
Fix repeated base path bug
0.2.5 (2016-3-25)
Add support for headers parameters.
0.2.4 (2016-3-23)
Improve the check of status code when ‘default’ is in the specification.
0.2.3 (2016-2-10)
Fix some errors (like file upload).
0.2.2 (2016-2-3)
Fix validation of standard types.
0.2.1 (2016-1-31)
Change license to MIT.
0.2.0 (2016-1-31)
Now support swagger APIs not made with connexion.
0.1 (2016-1-29)
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
Built Distribution
Hashes for swagger_tester-0.2.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 605cedfd9c76dd5134d4818d368f01aaa3cb595249c203bb2a67f4aa1d1b7518 |
|
MD5 | dbd3c35d38d68816d759ef3ea067a1d8 |
|
BLAKE2b-256 | cb1200a53fe91039716c1a0c7d6e75dd478f578b1c6c16e34be28593740427da |