Skip to main content

Getting Started

This article is a brief introduction to Apidog, including the basic functions and usage scenarios.

Video Content

Start Apidog

Upon opening Apidog, you will see the "My Workspace" automatically created by the system, which contains a "My Project".

my project

The project automatically generates several endpoints related to a pet store.

pet store APIs

Create an endpoint manually

Creating APIs manually is one of the most commonly used functions for developers. Apidog supports API design and debugging scenarios. During the API design phase, you can quickly create APIs in Apidog, define API-related information, and API request and response parameters.

You can refer to the existing sample endpoints by clicking the + button next to the search box on the left, and then clicking the "New API" button.

new api button

Apidog supports rich shortcut key operations. For detailed instructions, please read Hot Keys.

Import External APIs

Apidog supports importing API documents in formats such as Postman and Swagger. For a detailed list, please refer to Importing Data.

This chapter takes importing the commonly used Swagger format as an example to demonstrate how to import common API documents into Apidog:

Open the project settings panel and click the "Import Data (Manual Import)" option. You can choose to import files or URLs.

Import API from file

You can drag and drop the json or yaml file into the area shown in the figure below to import the file.

Import API from URL

When using the URL import method, you need to fill in the URL (direct link) of the json or yaml data file, not the URL of the Swagger UI.

Generate Online Documentation

Apidog supports generating online documentation for API documents. Online API documentation has a format that is easy to read and understand, as well as a searchable and interactive website. This makes APIs more easier to understand and use as well as reduce errors. If a member updates the API, the online documentation will take effect immediately, making it easier for team members to track the evolution of the API version.

For detailed instructions, please refer to Publishing Online Documentation.

Use Mock Data

Mocking is one of the core functions of Apidog. It helps devs in rapidly generating API responses during design or debugging phases, aiding front-end developers API debugging with its simulated data. For detailed instructions, please refer to Mock Function.

Sending Requests

Apidog is not only a powerful API management tool, but also provides developers with convenient API request functions. You do not need to enter complex command lines in the terminal. Instead, you can directly initiate requests on the visual page to obtain API response results.

Click the + button next to the search box on the left, and then click the "New Request" button.

In the request box, enter the complete request address and request parameters. Apidog will automatically identify the request parameters contained in the URL and display them in the request parameter list. You can modify the parameter values in the request parameter list, or click the "Params" button to manually add parameters. Click the "Send" button to obtain the API response result.

If the request response is normal, you can save this request as an API for later use.