Comprobación de integridad de la documentación de API
INFO
Descripción general
Comprobación de integridad de la documentación de API en su documentación de API actual y generar un informe de revisión detallado. Basándose en este informe, puede refinar y mejorar su documentación, lo que facilita la colaboración, hace que la documentación sea más fácil de leer y permite que todas las funciones de IA sean más eficaces gracias a especificaciones de endpoint más precisas.Qué se comprueba
Comprobación de integridad de la documentación de API, resulta útil revisar si las descripciones y definiciones de la documentación de API actual están completas. La comprobación analiza los siguientes aspectos:1. Definiciones básicas
| Elemento | Propósito |
|---|---|
| Método de petición | Define el método HTTP (GET, POST, PUT, DELETE) para determinar la semántica de la petición, la idempotencia y la estructura de parámetros |
| Ruta de la petición | La ruta URL completa (excluida la URL base) para identificar de forma única el endpoint e inferir la estructura de los parámetros de ruta |
| Nombre y descripción del endpoint | Breve explicación del propósito del endpoint para ayudar a los lectores y a la IA a comprender la lógica de negocio |
2. Descripciones de parámetros
| Elemento | Propósito |
|---|---|
| Nombre del parámetro | Garantiza que la estructura de parámetros esté completa, que la nomenclatura sea coherente y que cada parámetro esté en la ubicación correcta (Params, Body, Headers, Cookies) |
| Ejemplo | Proporciona valores de entrada de muestra válidos para ayudar a comprender valores típicos, formatos, tipos de datos y significado de negocio |
| Descripción | Explica el significado, el propósito y los escenarios de negocio del parámetro |
3. Restricciones de parámetros
| Restricción | Propósito |
|---|---|
| Obligatorio/Nullable | Indica si un parámetro es obligatorio y si se permiten valores nulos |
| Enums/Const | Enumera los posibles valores de enumeración o constantes y sus significados |
| Valores límite | Proporciona valores mínimos/máximos, límites de longitud y otras restricciones |
| Formato | Describe formatos especiales (date-time, email, uuid, binary, int64, json-string, etc.) |
4. Respuesta
| Elemento | Propósito |
|---|---|
| Cuerpo de la respuesta | Proporciona una estructura completa para el tipo de contenido de la respuesta, explicaciones de campos, códigos de estado HTTP y códigos de error |
Comprobación de integridad de la documentación de API
Comprobación de integridad de la documentación de API en la esquina superior derecha de una página de documentación de endpoint. Haga clic en ella para iniciar la comprobación.
Modified at 2026-06-09 08:52:14