Core workflows

Organize collections

1. Create a collection for each system or project.
2. Group requests by business domain or service.
3. Add descriptions, implementation notes, and response examples.
4. Use search, copy, and move to keep long-lived assets organized.

Import OpenAPI

Use the OpenAPI action to import OpenAPI 3.x JSON or YAML. Review:

• Whether server URLs match the current environment.
• Whether path and query parameters are complete.
• Whether authentication headers should become secret environment variables.
• Whether examples contain personal information or credentials.

Use environments

Define separate variables for development, test, and production integration. Mark passwords, tokens, and keys as secrets so the service encrypts them and the UI masks them.

Validation hints flag unresolved variables, invalid JSON, and duplicate headers. They help find mistakes early but do not replace target-service contract validation.

Run collections

1. Select a project and open Run.
2. Confirm the environment and target addresses.
3. Execute the collection and inspect each pass/fail result.
4. Restore failures to the request workspace for debugging.
5. Save stable responses as future comparison examples.

Project exports include folders, requests, environments, notes, and examples. Before moving a bundle across isolated environments, check for target addresses or sensitive business data that should not travel with it.