API Documentation Completeness Check

INFO

See Getting Started with AI Features for setup requirements. Note: This feature requires Apidog version 2.7.55 or later.

Overview

You can use AI to run an API Documentation Completeness Check on your current API documentation and generate a detailed review report. Based on this report, you can refine and improve your documentation — making collaboration smoother, the docs easier to read, and all AI features more effective thanks to more accurate endpoint specs.

What Is Checked

Before running the API Documentation Completeness Check, it's helpful to review whether the descriptions and definitions in the current API documentation are complete. The check analyzes the following aspects:

1. Basic Definitions

Check whether the endpoint documentation clearly and accurately specifies:

Element	Purpose
Request Method	Defines the HTTP method (GET, POST, PUT, DELETE) to determine request semantics, idempotency, and parameter structure
Request Path	The full URL path (excluding base URL) to uniquely identify the endpoint and infer path parameter structure
Endpoint Name and Description	Short explanation of the endpoint's purpose to help readers and AI understand business logic

📷 Basic Definitions Example

2. Parameter Descriptions

Check whether the endpoint documentation clearly and accurately specifies:

Element	Purpose
Parameter Name	Ensures parameter structure is complete, naming is consistent, and each parameter is in the correct location (Params, Body, Headers, Cookies)
Example	Provides valid sample input values to help understand typical values, formats, data types, and business meaning
Description	Explains the meaning, purpose, and business scenarios of the parameter

The basic information of request parameters can be generated or modified with the help of AI.

📷 Parameter Descriptions Example

3. Parameter Constraints

Check whether the endpoint documentation clearly and accurately specifies:

Constraint	Purpose
Required/Nullable	Indicates whether a parameter is required and whether null values are allowed
Enums/Const	Lists possible enum or constant values and their meanings
Boundary Values	Provides minimum/maximum values, length limits, and other constraints
Format	Describes special formats (date-time, email, uuid, binary, int64, json-string, etc.)

📷 Parameter Constraints Examples

4. Response

Check whether the API documentation clearly and accurately specifies:

Element	Purpose
Response Body	Provides complete structure for response content type, field explanations, HTTP status codes, and error codes

The basic information of responses can also be generated or modified with the help of AI.

📷 Response Example