Creating Projects

Last modified on October 14, 2021

Projects always belong to some organization. Personal accounts cannot have projects.

To create a project, you need to be an organization owner. Follow these steps:

1. Create a new project

  1. Click and select Create New Project.

    Creating a project in SwaggerHub
  2. On the next screen, specify the organization, to which the project will belong, and enter the project name and arbitrary description (up to 40 characters).

    Project name and organization

    Click the image to enlarge it.

    Notes:

    • The project name and description can include any characters. The name can have up to 20 characters, the description – up to 40 characters.

    • The project name cannot coincide with the name of some other project in the organization you selected.
      An organization cannot have two projects with the same name.

    • The project name can coincide with API and domain names. For example, you can have an API called Petstore and a project called Petstore.

    • Check if you typed the name correctly. Projects cannot be renamed in the future.

  3. After you specified the organization and entered the project name, click Create Project.

The created project appears under the organization name in the sidebar:

Projects in SwaggerHub sidebar

2. Select APIs and domains

After you created the project, you can add APIs and domains to it. You can do this now, or any time later.

To add APIs and domains, click within the Search box and select an API or domain from the drop-down list:

Adding APIs and domains to a project

Click the image to enlarge it.

To find your API or domain faster, enter any part of its name in the Search box. SwaggerHub will filter the drop-down list on the fly. You can add as many APIs and domains, as needed.

Note: The list contains only those APIs, which your organization owns (including private APIs). If you do not see an API or domain on the list, then, most likely, your organization does not own it. In this case, you can skip this step, and add the API or domain to your project later, after you transfer the API (or domain) ownership to the organization.

SwaggerHub does not automatically save the changes you made to the list of APIs and domains. To save the changes, you should go to the next step and click Save there.

3. Invite members

In this step, you can add users to your project. You can do this now or any time later.

To invite users now, click within the Search box and select the desired user from the drop-down list:

Adding users to a project in SwaggerHub

To find a user faster, enter any part of the username in the Search box. The drop-down list will be filtered on the fly. You can invite as many users as needed.

Note: The list displays only the members of your organization. If you do not see the needed user on the list, you have to add that user to your organization first.

4. Complete project configuration

After you added APIs and domains to the project and invited users, click Save on the Invite Members page. This will save the changes you made to the API and user lists.

Configure projects

For information on configuring existing projects, see other pages of the Projects section.

See Also

Projects

Highlight search results