Detectar problemas en una API importada

Cuando importa una API (OpenAPI, Swagger y los demás formatos compatibles), Restorm conserva la documentación estructurada de la API en su carpeta de variables. Justo después de la importación — y cada vez que vuelve a abrir el archivo —, Restorm proyecta discretamente esa documentación en un diseño y ejecuta la misma validación que aplica el diseñador de API, por completo en segundo plano. Nunca bloquea la importación ni interrumpe lo que está haciendo.

Si no encuentra nada, no ve nada. Si encuentra problemas estructurales, se los señala en dos lugares.

El «!» en la barra lateral

La carpeta de variables que contiene la API marcada muestra un pequeño «!» a la derecha de su fila. Es la señal, de un vistazo, de que el diseño de esta API tiene algo que merece una mirada — y desaparece por sí sola en cuanto la API vuelve a estar limpia (tras una reimportación o una actualización de la API que lo corrija).

La pestaña «Problemas»

Abra la carpeta de variables y aparecerá una pestaña «Problemas». La pestaña solo aparece cuando se detectaron problemas — una API limpia nunca la muestra.

Los problemas se agrupan por tipo, de modo que veinte rutas duplicadas se leen como una sola línea con un recuento en lugar de veinte entradas separadas. Bajo cada tipo, Restorm enumera las entidades exactas afectadas — una ruta muestra su verbo HTTP y su ruta real y se despliega hasta la documentación de esa ruta, de modo que puede ver lo que declara sin salir de la pestaña.

Las comprobaciones reflejan las del diseñador de API, así que los tipos de problemas que puede ver incluyen:

• rutas duplicadas — dos rutas que responden al mismo método y a la misma ruta;
• respuestas ausentes — una ruta que no declara ninguna respuesta;
• rutas reservadas — una ruta que se encuentra en una ruta que el Mock Server reserva (/swagger.json, /graphql, …) y que nunca respondería;
• problemas de restricciones — un patrón no válido o un mínimo superior a su máximo.

La lista es de solo lectura: le indica qué corregir, y usted lo corrige en el origen (reimporte una especificación corregida o edite la API). Se recalcula en los eventos que cambian una API — una apertura de archivo, una importación, una actualización de la API — no con cada pulsación de tecla.