How to Use Apidog

Getting started with Apidog

In this guide, you'll learn how to set up Apidog and create your first API project. By the end, you'll be able to design, test, and document APIs efficiently using this all-in-one platform.

Step 1: Sign up and set up

1. Go to the Apidog website.
2. Click on the "Sign Up" button in the top right corner.
3. Fill in your email and create a password, or sign up using your Google or GitHub account.
4. Confirm your email address if prompted.
5. Once logged in, you’ll be directed to the dashboard where you can start your first project.

Step 2: Your first API project

1. From the dashboard, click on the "New Project" button.
2. Enter a name and description for your API project.
3. Click "Create" to open the API design interface.
4. Use the left sidebar to define your API endpoints. Click the "Add Endpoint" button to create a new one.
5. Fill in the details for your endpoint, including the method (GET, POST, etc.), URL path, and any parameters or request bodies needed.
6. Click "Save" to store your endpoint configuration.

Step 3: Get better results

1. Use the "Testing" tab to run tests on your API endpoints. Click on the endpoint you want to test, then select "Test" from the options.
2. Input any required parameters and click the "Send" button to see the response.
3. For documentation, navigate to the "Documentation" tab. Apidog automatically generates documentation based on your API design. Review and edit as necessary.
4. Use the "Import" feature to bring in existing API specifications (like OpenAPI) to save time on setup.

Pro tip

Take advantage of the "Templates" feature when creating endpoints. You can save common configurations and reuse them, speeding up the design process.

Common mistake to avoid

A common mistake is neglecting to test your endpoints after creating them. Always run tests to ensure they behave as expected before finalising your API design.