Creating an API project in VCS

Edit online

Before you begin

Make sure to connect to a GitHub repository to save API projects in VCS. For more information, see Version Control System Integration.

About this task

To collaborate on an API project with version control, create the project in a Version Control System (VCS). This approach enables team members to track changes, manage versions, and work on different branches, and it maintains a centralized repository for project files.

Procedure

  1. Click New API project on the home page.
    A dialog box appears for creating a new API project.
  2. In the New API project dialog box, choose one of the following options:
    • Select Start new project > From repository
    1. Select a repository from the Repository drop-down menu to save the project.
    2. Select a branch from the Branch drop-down menu.
    3. Provide the following details:
      • Project name. Provide a name for your project.
      • Description. Add a brief summary or purpose of the project.
      • Tags. Add relevant tags to categorize or identify the project easily. Type a tag name and press Enter to add it.
    • Select Import file > From repository
    1. Select a repository from the Repository drop-down menu to save the project.
    2. Provide the following details:
      • Project name. Provide a name for your project.
      • Description. Add a brief summary or purpose of the project.
      • Tags. Add relevant tags to categorize or identify the project easily. Type a tag name and press Enter to add it.
    3. Drag files in the Select files section or click the Select files section to upload files from the repository or branch..
  3. Click Create.

    After you create the project, API Studio redirects you to the home page and display the newly created project. You can start working on your APIs and policies within the project.