Effective API testing, simplified

Integrate Schemathesis into your GitHub Actions workflows for automated API testing. Receive detailed test reports directly in your GitHub pull requests, simplifying the review process and ensuring API consistency.

• Automated API Testing: Generate and execute tests against your API based on its schema.
• Pull Request Comments: Receive detailed test reports as comments in your GitHub pull requests.
• GitHub Checks Status Updates: Get updates on test execution status directly in your GitHub checks.

Integration

• Install the app
• Grant access to the repository where you want to run Schemathesis
• Include the following workflow in your GitHub Actions to start testing your API with Schemathesis:

jobs:
  api-tests:
    runs-on: ubuntu-latest
    steps:
      - uses: schemathesis/action@v1
        with:
          schema: 'https://example.schemathesis.io/openapi.json'
          # Optional, for PR comments
          token: ${{ secrets.SCHEMATHESIS_TOKEN }}

To get test results as comments in your GitHub pull requests, both the token and the GitHub app are required. Obtain the token by signing up on Schemathesis.io.

Support

• Documentation: Read the Docs
• Community: Join our Discord channel for active community support.