APl design guidelines

Apidog version 2.7.22or later is required.

Apidog strongly recommends that all API documentation be designed in compliance with the OpenAPI (Swagger) Specification. You can refer to this article to understand why following this specification is important for your APIs.

Many of Apidog's other features, such as AI-powered endpoint compliance check, AI naming, and more, rely on a complete and well-defined API design guideline. With a standardized guideline:

Other Apidog features work more effectively

Your team is aligned and follows consistent design principles

In Apidog, you can create a new API design guidelines by clicking "+"> "New APl design guidelines" above the folder tree.

When creating a new API design guideline, you'll have two options:

Example template(recommended)
Use the complete API design guideline template provided by Apidog. This is the recommended choice in most cases. The template is based on the OAS (OpenAPI Specification) and compiled with reference to Microsoft's best practices for API design.

Blank template
Create a blank design template. This option only provides the basic structure of a specification without detailed content. You can then write your team's own API design guidelines. If your team already has established standards and best practices, this may be the better starting point.

After selecting, previewing and confirming the template that fits your needs, a new API design guideline will be created within your project. You can fully customize its contents as needed. The design guideline will be displayed at the top of the folder tree to remind all team members of the importance of the specifications.

Learn more: Endpoint compliance check.