// DOCUMENTATION
Importing an API
Import an OpenAPI or Swagger JSON file, or connect a JSON or YAML URL source.
Supported formats
REST Test currently accepts OpenAPI 3.x and Swagger 2.0 JSON. YAML sources are supported through recognized .yaml/.yml URLs and GitHub; local file upload uses JSON.
- OpenAPI 3.0 and 3.1 JSON
- Swagger 2.0 JSON
- Local file upload
- Remote definition URL
Import from a file
Choose JSON file import, select the definition and review the detected format before saving it to the workspace. Invalid JSON and unsupported definition versions are rejected.
{
"openapi": "3.1.0",
"info": { "title": "Payments API", "version": "1.0.0" },
"paths": {}
}Import from a URL
Open Settings > API Source and select a URL source. Enter a JSON URL, or a YAML URL ending in .yaml/.yml (or served with a YAML content type). Choose Cloud Runner or Browser Runner for fetching, preview the detected operations, then save.
- Cloud fetching requires a reachable URL allowed by server network protections. Browser fetching requires the source server to allow CORS.
- The response must be valid JSON or recognized YAML, with a supported OpenAPI or Swagger version.
- Configure source authentication in the source settings. Never put a token in a source URL.