Test Documentation
Guides and reference material for Test.
Overview
Private Workspaces
How to Write Tests
- How to Write Tests1. To start with Swagger Functional Testing, select Functional Testing from the left navigation panel of the Swagger Catalog main page.
- Default HeadersTo help users run successful API calls with less setup time, now includes default headers automatically for each API request. This guide explains how the…
- Link API Step from StudioWhen you create a test step using Swagger Studio API definition, Swagger Functional Testing links the step to the source API operation. The link state is…
Navigation
- NavigationThe Navigation section serves as your central hub for accessing and managing all key components of your API testing workflows. Explore the following tabs:
- TestsCreate a Test
- RunsThe Runs view, which you can access by clicking on the Runs tab at the top of the page, shows all test runs that are still pending or in progress, as well…
- SuitesA suite encompasses a complete regression testing plan, from the individual test cases and their environments to the email notifications on failures.
- Suites APIExecute suites and retrieve results via CI/CD and other external systems.
- GlobalsAccount Variables are global, reusable identifiers that allow you to store and manage key-value pairs used across your test steps in . These variables can…
Import Data
- Import DataIn This Section
- Import Postman CollectionQuickly migrate your existing Postman collections into Swagger Functional Test and start running API tests without rebuilding them from scratch.
- Import from cURLConvert a cURL command into an API test step without manual setup.
- Export as cURLExport a test step's API request as a cURL command to use outside of Swagger Functional Testing.
Authentication and Authorization
Dynamic Values
- Dynamic ValuesDynamic values play a crucial role in API testing by making tests more adaptable, reusable, and effective. Instead of hardcoding static values, testers…
- VariablesVariables allow you to capture and reuse dynamic values within a single API test. This is particularly useful for scenarios where unique or…
- AssertionsSwagger Functional Testing can extract text from the response body.
- JavaScript StepsSwagger Functional Testing, you can enhance your API testing workflows by executing custom JavaScript code. This feature lets you interact with…
Private Environments
Segments and Composition
Automation
- AutomationSwagger Functional Testing allows you to automatically execute tests and suites within your Continuous Integration/Continuous Deployment pipeline. See…
- MCP ServerSwagger Functional Testing supports the Model Context Protocol (MCP), which lets AI coding assistants such as Claude, Cursor, and GitHub Copilot interact…
- Continuous Integration (CI/CD)Instructions below describe how to trigger an API request using the following CI/CD tools: Azure, Bitbucket, CircleCI, GitHub, Heroku, Jenkins, Coherence,…
- Tests APIExecute tests and get the status of individual test runs.
- Suites APIExecute suites and retrieve results via CI/CD and other external systems.
Integrations
- IntegrationsLearn how to integrate Swagger Functional Testing into your existing development and/or testing workflows.
- Email NotificationsGet automated alerts when tests start failing.
- Issue TrackersCreate bug tickets for failing tests directly from Swagger Functional Testing.
- Continuous Integration (CI/CD)Instructions below describe how to trigger an API request using the following CI/CD tools: Azure, Bitbucket, CircleCI, GitHub, Heroku, Jenkins, Coherence,…
- SlackSend automatic notifications to a Slack channel of your choice when tests fail.
- GitHubConnect to GitHub to allow Swagger Functional Testing to run tests on every Pull Request and mark PRs as passing/failing.
- Test Case ManagementAutomatically sync Swagger Functional Testing tests and test results to your existing Test Case Management tool.