Managing Projects

A project is a group of an organization’s APIs and domains. A single API or domain can belong to multiple projects. Only SmartBear administrators and Organization Owners can add APIs to a project in the Swagger Catalog.

Add to Projects

Adding Projects

When you createimport, or fork definitions into an organization, you have the option to add this definition to an existing project or a new project.

To add APIs to an existing project, do the following:

  1. In the Organization API screen, under Project, click Add to Project.

  2. Select the Existing Project option.

    The Add API to the existing project dialog box appears.

    Add API to existing project
  3. Select the required project from the Select Project list.

  4. Click Confirm.

The API is added to the project, and you are navigated to the Swagger Studio project settings page. See Project Settings to add and delete APIs and domains from projects.

Tip

You can create new projects, link them with APIs and domains , or invite members  to add users to the project in Swagger Catalog

Understanding Project Status

The following are the available project statuses:

Status

Description

View

Appears after adding an API to the project. Only users with the required permissions can view the project.

No Projects

Appears when no API is added to any projects. The user does not have permissions to add an API.

No Permissions

The user does not have access to the project. To gain access, they need to upgrade their plan.

Working with Projects

You can view or edit an API, preview its details, or open it in Swagger Explore. See Swagger Explore documentation for more information. To perform these actions, do the following:

  • Click the View Swag_Cat_eye_1_4.png Icon to view an API. The API details appear in the right pane.

  • Click Open in Editor Swag_Cat_editor_1_4.png icon to write, edit, and preview your API definitions in real time. You are navigated to Swagger Studio Code Editor.

  • Click Generate MCP Server Swag_Cat_MCP_1_5.png icon to generate an MCP server for the API definitions. See Generating MCP Server.

Note

Refer to Swagger Studio documentation for an overview of user roles and the resource access for each role.

Publication date: