Create a new API project

In Apidog, each project corresponds to an API Specification or an OpenAPI Specification (OAS) file. You can create a new API project or import an existing one from Home - My Teams - Projects section of the Apidog app.

Creating a Project

Click on New Project.

Select the project type. Apidog currently supports two types of projects: HTTP and gRPC.

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 Project Permissions 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 easily import it into Apidog. Apidog supports various API formats, making it simple to integrate your existing specifications regardless of the original format.

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.

Choose the type of data you wish to import. Apidog supports a variety of data formats, including OpenAPI (Swagger), Postman, .har, apiDoc, RAML, JMeter, I/O Docs, WADL, Google Discovery, and more.

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

Create a new API project

Creating a Project#

Import existing APIs#

Creating a Project

Import existing APIs