https://github.com/schemathesis/action
GitHub Action that runs Schemathesis tests
https://github.com/schemathesis/action
actions api-testing github-actions testing
Last synced: 3 months ago
JSON representation
GitHub Action that runs Schemathesis tests
- Host: GitHub
- URL: https://github.com/schemathesis/action
- Owner: schemathesis
- Created: 2022-05-02T11:07:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-09T20:33:56.000Z (4 months ago)
- Last Synced: 2025-04-18T12:19:19.906Z (3 months ago)
- Topics: actions, api-testing, github-actions, testing
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Schemathesis GitHub Action
A GitHub Action for running [Schemathesis](https://github.com/schemathesis/schemathesis) API tests. Automate your API testing to catch crashes, validate specs, and save time.
```yaml
- uses: schemathesis/action@v1
with:
# API schema location
schema: 'https://example.schemathesis.io/openapi.json'
```
## Configuration
```yaml
- uses: schemathesis/action@v1
with:
# API schema location
schema: 'https://example.schemathesis.io/openapi.json'
# OPTIONAL. URL that will be used as a prefix for all API operations.
# Useful when the API schema is maintained separately from the application.
base-url: 'https://example.schemathesis.io/v2/'
# OPTIONAL. List of Schemathesis checks to run. Defaults to `all`
checks: 'not_a_server_error'
# OPTIONAL. Maximum time in seconds to wait on the API schema availability
wait-for-schema: '30'
# OPTIONAL. Maximum number of generated examples for each endpoint
max-examples: 50
# OPTIONAL. Specify which version of Schemathesis should be used.
# Defaults to `latest`
version: 'latest'
# OPTIONAL. Schemathesis hooks module. Available for Schemathesis >= 3.18.5 only
hooks: 'tests.hooks'
# OPTIONAL. Extra arguments to pass to Schemathesis
args: '-D negative'
```
To add headers like `Authorization`:
```yaml
# Save access token to $GITHUB_ENV as ACCESS_TOKEN.
- name: Set access token
run: echo "ACCESS_TOKEN=super-secret" >> $GITHUB_ENV
- uses: schemathesis/action@v1
with:
schema: 'http://example.com/api/openapi.json'
args: '-H "Authorization: Bearer ${{ env.ACCESS_TOKEN }}"'
```
For more options and usage, check the [Schemathesis CLI documentation](https://schemathesis.readthedocs.io/en/stable/cli.html).
## Support
Having issues or questions? Check the [Schemathesis documentation](https://schemathesis.readthedocs.io/en/stable/), join the [Discord community](https://discord.gg/R9ASRAmHnA), or report problems on the [GitHub issue tracker](https://github.com/schemathesis/action/issues).