Overview

Welcome to the Apidog Documentation. Here, you can find guidance on using Apidog effectively.

Use the topics below to locate the information you need.

Introduction

Discover the design concept and features of Apidog, along with functional guidance for specific roles, including API designers, backend developers, frontend developers, and QA engineers.

Get Started

If you're new to API tools, this is the place to start. Learn about Apidog and create your first API project. You’ll also find information on the basics and components of Apidog, as well as how to import and export data.

Send Requests

Sending requests is a fundamental function of Apidog. It supports various protocols, including HTTP, GraphQL, gRPC, WebSocket, and SOAP/WebService.

Design APIs

Use Apidog's visual interface to design APIs. Features include templates and components that help speed up API design and generate examples for requests and responses.

Develop and Debug APIs

Generate requests based on API specifications, send them, and automatically check the responses. Apidog supports visual pre- and post-processing tasks, allows you to manipulate variables, and perform database actions. It fully supports Postman scripts, enabling you to use dynamic values for request parameters.

Mock API Data

Apidog can create mock data automatically based on the API specifications. You can customize mock responses, scripts, and even set up cloud-based mock servers.

Automated Testing

A test scenario consists of multiple requests. You can import requests from endpoint specifications and keep them updated as the API specs change, either automatically or manually.

Test scenarios also include logic components like If, for, and forEach. You can pass data between requests and dynamically create request parameters. Additionally, you can view test reports, run performance tests, manage test data, and integrate with CI/CD processes.

Publish APIs

Apidog can automatically create API documentation based on specifications. The online documentation allows for interactive testing and code generation. You can also customize aspects such as the domain, color scheme, and structure.

Branches

With Sprint branches, team members can work collaboratively on different branches and merge changes back to the main branch once API design and debugging are completed.

Best Practices

Explore best practices for using Apidog, including managing signatures and login states.

Administration

Apidog offers comprehensive management options for organizations, teams, projects, members, and permissions.

Billing

Learn about Apidog's upgrade options, billing rules, and credits.

Account & Preferences

Settings for account management, language preferences, proxies, and access tokens.

References

Access related reference materials.

Apidog Europe

Information about the Apidog service available in Europe, specifically deployed in Ireland.