In Apidog, projects are the core workspace where you design, test, and document your APIs. This guide covers creating, managing, and organizing projects within your team.Creating a Project#
To create a new project, navigate to your team and click New Project. During project creation, you can configure the project details and specify how existing team members can access the project.Assigning Project Permissions to Team Members#
Use Other Members' Project Permissions to set the project roles of existing members in the team:Team Members are assigned the selected project role. If no role preference has been saved for the current team, Read-only is selected by default.
Team Owners and Team Admins are always assigned the Admin project role, regardless of the selected option.
Guests are always assigned the Forbidden project role and cannot access the project.
To assign roles individually, select Customize and configure a project role for each member.
Project Overview#
In an existing project, you can view key information and statistics on the Overview page under APIs.Endpoint Case/Test Scenario Stats#
This section displays all the endpoints of the current project and provides statistics on testing coverage. It shows the percentage of endpoints that have associated test steps, as well as the percentage that have been tested within test scenarios. These statistics are valuable for evaluating the thoroughness of the API testing and their overall reliability.Coverage of endpoint case: The number of endpoints with associated cases / Total number of endpoints. This is mainly used to check if individual endpoints have corresponding cases.
Average cases per endpoint: The total number of cases / Total number of endpoints. This is mainly used to assess the overall completeness of endpoint cases.
Endpoints without cases: This shows the number of endpoints that have no cases.
Coverage of test scenario: The number of endpoints covered in test scenarios / Total number of endpoints. This is mainly used to assess the extent to which endpoints are covered by automated tests.
Endpoints not covered by any test scenario: This shows the number of endpoints that are not yet covered by automated tests.
Data calculation is asynchronous, so there may be a delay. If discrepancies occur, refresh after a moment to confirm.
Editing the Project#
The team owner/administrator enters the created project and changes the project name or project icon in Settings → Basic Settings.Cloning the Project#
To clone a project from current team to another team, click Settings → Basic Settings → Clone Project.Moving the Project#
To move a project to another team, click Settings → Basic Settings → Move Project.Deleting the Project#
To delete a project completely, go to Settings → Basic Settings → Delete.You must be cautious - projects deleted will not be retrievable.
