Organization method of endpoints

In Apidog, every project is made up of multiple modules. Each module represents a single endpoint specification file — commonly known as OpenAPI Specification (OAS) file.

You can start a new API project in the Apidog app by going to Home → My Team → New Project. Alternatively, you can create a project by importing an existing endpoint specication or API data from other platforms.

Creating a Project

In the main window, click the + New Project button at the top right.

Select the project type. Apidog currently supports two types: HTTPandgRPC.

HTTP: Choose this for APIs like REST, SOAP, GraphQL, WebSocket, etc.

gRPC: Select this for APIs that use the gRPC protocol. Learn more about gRPC projects.

Enter the name for your project.

(Optional) Check the Including Examples option to create a project with sample data from the PetStore example.

(For teams with multiple users) Set permissions for other team members during project creation. For more information, see Member permissions settings.

(Optional) Set the Project language. For more information, see Language settings.

Import existing APIs

If you already have an API Specification, you can initiate the import process either from the Team - Projects section by selecting Import Project, or directly within an existing project by clicking the large ➕ sign and choosing Import. This is ideal for migrating existing API data into Apidog.

Click "Import Project"

Choose the type of data you wish to import.

Upload the file or paste the data URL(OpenAPI/Swagger formats only).

Apidog will automatically recognize and parse the content based on the selected format. You’ll be able to preview the data before importing. Choose what you want to import and configure the import logic. Then confirm to create and import the project.

Once the import is complete, your new project will be ready to use.

For more detailed information about the import process, please refer to the Import Guidelines.

Organization method of endpoints

Creating a Project#

Import existing APIs#

Creating a Project

Import existing APIs