Comprobación de cumplimiento del endpoint

INFO

Consulte Introducción a las funciones de IA para conocer los requisitos de configuración.

Descripción general

Puede utilizar la IA para realizar una comprobación de cumplimiento del endpoint en su documentación de API actual basada en las directrices de diseño de API. La IA generará un informe completo para ayudarle a mejorar su documentación de API de modo que se alinee mejor con los estándares de diseño, haciéndola más profesional, coherente y fácil de leer.

Qué evalúa la comprobación de cumplimiento

La IA analiza su endpoint según múltiples criterios:

Criterios	Descripción
Convenciones de nomenclatura	Comprueba si las rutas de endpoint, los parámetros y los campos siguen patrones de nomenclatura estándar
Integridad de la documentación	Verifica que se proporcionen descripciones, ejemplos y restricciones
Uso de métodos HTTP	Garantiza el uso adecuado de GET, POST, PUT, DELETE, etc.
Estructura de la respuesta	Valida el formato de la respuesta y la gestión de errores
Prácticas de seguridad	Revisa los requisitos de autenticación y autorización

Uso de la comprobación de cumplimiento del endpoint

Puede acceder a la función de comprobación de cumplimiento del endpoint desde la esquina superior derecha de cualquier página de documentación de API. Simplemente haga clic en ella para iniciar la comprobación de cumplimiento del endpoint impulsada por IA.

Después de hacer clic en el botón Endpoint compliance check, la IA analizará la documentación de API basándose en las directrices de diseño de API. A continuación, proporcionará una puntuación para cada criterio de evaluación, junto con explicaciones detalladas y sugerencias de mejora.

Comprobar las directrices de diseño de endpoints

Comprobación de cumplimiento del endpoint

Descripción general#

Qué evalúa la comprobación de cumplimiento#

Uso de la comprobación de cumplimiento del endpoint#

Descripción general

Qué evalúa la comprobación de cumplimiento

Uso de la comprobación de cumplimiento del endpoint