Getting started

Overview

Total Shift Left helps you shift API quality left by turning your OpenAPI/Swagger contract into repeatable tests, coverage insights, and CI-ready runs.

This guide is the shortest path to a “first success” run:

• Create a workspace + project
• Connect an API specification
• Configure base URL + auth
• Generate a baseline test suite
• Run tests and review results

Prerequisites

• An OpenAPI (3.x) or Swagger (2.0) specification for your API
• Access to the API environment you want to test (dev/stage recommended)
• A CI system (optional for later): GitHub Actions, GitLab CI, Jenkins, etc.

Choose your installation path

Pick the path that matches your constraints and timeline.

Cloud (recommended for fastest setup)

1. Create a workspace in Total Shift Left.
2. Add a project and upload or link your OpenAPI spec.
3. Configure the base URL and auth for the environment you want to test (dev/stage).

Self-hosted (when you need full control)

If you’re deploying in your own environment, you’ll typically:

1. Deploy the Total Shift Left application service.
2. Provision a database (if required by your deployment model).
3. Configure environment variables (see Configuration fundamentals).
4. Verify the service is reachable and can execute test runs.

If you’re self-hosting on Windows with the desktop installer, follow: Install on Windows (Self-hosted Installer).

Connect your API spec

You can usually connect your spec in one of these ways:

• Upload a file (openapi.yaml / openapi.json)
• Link to a URL where the spec is published
• Sync from your repo as part of CI/CD

If you’re new to the platform, start with: Platform overview.

Generate your first tests

After the spec is connected, generate a baseline set of tests:

• Start with read-only endpoints first (safe baseline).
• Expand to write endpoints once auth and data setup are configured.
• Use tags/paths to scope initial runs so results are fast and focused.

Related: AI-generated tests and Test case.

Run tests

Run the generated suite against your chosen environment:

• Confirm base URL, headers, and auth are configured (see Configuration fundamentals).
• Run a small subset (1–3 endpoints) first to validate connectivity.
• Then run the full suite and review coverage and failures.

Related: Test run, Test configuration, and Detailed test report.

Troubleshooting quick checks

• 401/403: verify auth header and token scope.
• 404: base URL mismatch or path/server mismatch vs the spec.
• TLS/SSL errors: verify certificates and outbound network rules.
• Flaky tests: check environment stability and data dependencies.

What to read next

• Configuration fundamentals
• Initial configuration
• Understanding workflows
• Release notes