Directrices de diseño de API

Se requiere Apidog versión 2.7.22 o posterior.

Apidog recomienda encarecidamente que toda la documentación de API se diseñe de conformidad con la Especificación OpenAPI (Swagger). Puede consultar este artículo para comprender por qué seguir esta especificación es importante para sus API.

Muchas de las demás funciones de Apidog, como la comprobación de cumplimiento de endpoints impulsada por IA, la nomenclatura con IA y otras, dependen de una directriz de diseño de API completa y bien definida. Con una directriz estandarizada:

Otras funciones de Apidog funcionan con mayor eficacia

Su equipo está alineado y sigue principios de diseño coherentes

En Apidog, puede crear nuevas directrices de diseño de API haciendo clic en "+"> "New APl design guidelines" encima del árbol de carpetas.

Al crear nuevas directrices de diseño de API, tendrá dos opciones:

Plantilla de ejemplo (recomendada)
Use la plantilla completa de directrices de diseño de API proporcionada por Apidog. Esta es la opción recomendada en la mayoría de los casos. La plantilla se basa en OAS (OpenAPI Specification) y se ha elaborado tomando como referencia las mejores prácticas de Microsoft para el diseño de API.

Plantilla en blanco
Cree una plantilla de diseño en blanco. Esta opción solo proporciona la estructura básica de una especificación sin contenido detallado. Luego puede redactar las directrices de diseño de API propias de su equipo. Si su equipo ya cuenta con estándares y mejores prácticas establecidos, esta puede ser un mejor punto de partida.

Después de seleccionar, previsualizar y confirmar la plantilla que se ajuste a sus necesidades, se crearán nuevas directrices de diseño de API dentro de su proyecto. Puede personalizar completamente su contenido según sea necesario. Las directrices de diseño se mostrarán en la parte superior del árbol de carpetas para recordar a todos los miembros del equipo la importancia de las especificaciones.

Más información: Comprobación de cumplimiento de endpoints.