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 = {
'get': {
'/pet/': ['400', '404']
}
}
# 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 on http://localhost:8080/v1
swagger_test(app_url='http://localhost:8080/v1', 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.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.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc1ce12c0dd3585c90ff3622407ed0881cdcae633eb6125976fbce9ee5847118 |
|
MD5 | 3ab62adbe85df9d7e9b09fbd27f236e4 |
|
BLAKE2b-256 | 3b9a7d887c7273714cf7cbcedb0528747675d06aea563061c3e85661631b8e3d |