Project

Overview

A project is the workspace where you organize an API from spec → endpoints → tests → runs. It’s the starting point for:

• importing or syncing an OpenAPI/Swagger spec
• grouping endpoints into features
• creating test cases and test run packs
• managing environments and access controls

If you’re new, start with Getting started and Initial configuration.

Create a project

1. Go to Projects.
2. Select New project.
3. Fill in:
   • Name (clear and specific, e.g. “User Management API”)
   • Description (optional, but helpful for teams)
   • Default environment (start with Dev/QA until runs are stable)
4. Select Create.

Recommended conventions

• Name projects by domain: align with an API boundary (Billing, Identity, Orders).
• Keep environments separate: dev vs stage vs prod—avoid mixing credentials and data.
• Set access early: assign roles so editing, running, and viewing permissions are clear.

What to do next

• Add endpoints: Endpoint import and discovery
• Organize them: Feature management
• Configure variables: Test configuration
• Run a first validation: Test run

Related articles

• Project settings
• Managing projects
• Project operations