README
¶
OASIS
Open API Specification Intelligence Services. Or in a less fancy way, a tool to test APIs which uses OAS/Swagger spec files as a test suite.
Work in progress.
Usage
Oasis can be used either in manual mode, which allows to test single operations, or in script mode, which is designed to test complex interaction scenarios, involving multiple endpoints and reusing data across them.
☑️ Manual mode
run/oasis from spec/petstore.yaml test findPetsByStatus
Oasis uses the example value for the status query parameter for the findPetsByStatus operation defined in the spec file.
You can override any parameter from CLI:
run/oasis from spec/petstore.yaml test getPetById use path parameters petId=10
Increase logging verbosity to see how parameters are used.
run/oasis from spec/petstore.yaml test getPetById log at level 6 use path parameters petId=10
For an example of error reporting use the malformed spec file which doesn't correspond to the actual API responses:
run/oasis from spec/errors.yaml test taskList log at level 6
run/oasis from spec/errors.yaml test configTypes log at level 6
📖 Learn more about operation parameters
🔀 Script mode
For complex scenarios involving multiple endpoints and data reuse across them there is a script mode:
run/oasis execute script/petstore.yaml
run/oasis execute script/nuxeo.yaml
Script is a graph of dependent operations. Cycles are not allowed:
run/oasis execute script/cycle.yaml
Directories