Schemathesis
ActionsTags
(2)GitHub Action for running Schemathesis property-based API tests against OpenAPI and GraphQL schemas.
- uses: schemathesis/action@v3
with:
# API schema location
schema: 'https://example.schemathesis.io/openapi.json'- uses: schemathesis/action@v3
with:
# API schema location (URL or file path)
schema: 'https://example.schemathesis.io/openapi.json'
# Override base URL
base-url: 'https://example.schemathesis.io/v2/'
# Validation checks to run (default: all)
checks: 'not_a_server_error'
# Schema availability timeout in seconds
wait-for-schema: '30'
# Test cases per API operation
max-examples: 50
# Schemathesis version (default: latest)
version: 'latest'
# Python module path for hooks
hooks: 'tests.hooks'
# Path to a `schemathesis.toml` configuration file
config-file: 'tests/schemathesis-config.yaml'
# Authorization header value
authorization: 'Bearer ${{ secrets.API_TOKEN }}'
# Additional CLI arguments
args: '--report-junit-path=/tmp/junit.xml'
# Schema coverage (default: true)
coverage: 'true'
coverage-report: 'true'
coverage-report-path: 'schema-coverage.html'
coverage-artifact-name: 'schema-coverage-report'
coverage-pr-comment: 'true'
# Write coverage summary to the workflow step summary
# set to false when using the action multiple times in one job
coverage-step-summary: 'true'To authenticate requests:
- name: Run with authentication
uses: schemathesis/action@v3
with:
schema: 'http://example.com/api/openapi.json'
authorization: 'Bearer ${{ secrets.API_TOKEN }}'For other schemes (Basic, custom):
authorization: 'Basic ${{ secrets.ENCODED_CREDENTIALS }}'For additional options, see the Schemathesis CLI reference.
Schema coverage is powered by tracecov and enabled by default. Each run generates:
- A summary in the Actions step summary
- An HTML report uploaded as a workflow artifact (default name:
schema-coverage-report) - A PR comment with the coverage summary (pull requests only)
Coverage reports are generated even when schemathesis finds failures.
PR comments require pull-requests: write in your workflow:
jobs:
test:
permissions:
pull-requests: write
steps:
- uses: schemathesis/action@v3
with:
schema: 'http://example.com/api/openapi.json'If you run the action more than once in a single workflow, set distinct artifact names to avoid conflicts:
- uses: schemathesis/action@v3
with:
schema: 'http://example.com/api/v1/openapi.json'
coverage-artifact-name: 'coverage-v1'
- uses: schemathesis/action@v3
with:
schema: 'http://example.com/api/v2/openapi.json'
coverage-artifact-name: 'coverage-v2'To disable coverage entirely:
coverage: 'false'Additionally, you may add the coverage and schemathesis run reports to the GitHub actions job summary page by adding the steps below.
- name: Publish test report
uses: dorny/test-reporter@v2
if: always()
with:
name: Schemathesis
path: schemathesis-report/*.xml
reporter: java-junit
- name: Upload test results
uses: actions/upload-artifact@v7
if: always()
with:
name: schemathesis-results
path: schemathesis-report/This will result in the following sections being added to the job summary page
Schemathesis is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)Schemathesis is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.