Importar desde OpenAPI / Swagger

Si ya describes tu API con una especificación OpenAPI 3.x o Swagger 2.0, no tienes que recrear cada endpoint a mano en LoadFocus. Importa la especificación y LoadFocus genera un monitor de API por operación — método, URL y una comprobación de código de estado — en un solo paso.

Funciona con OpenAPI 3.x y Swagger 2.0, en JSON o YAML, y se ejecuta por completo dentro de tu cuenta y tu equipo activo, con los límites de tu plan aplicados igual que en el panel.

Cómo funciona

1. Abre API Monitoring y ve a la lista de checks.
2. Haz clic en Importar desde OpenAPI.
3. Puedes pegar el texto de la especificación o indicar una URL que LoadFocus carga por ti.
4. Elige la frecuencia y si los checks importados empiezan activos.
5. Haz clic en Importar. LoadFocus analiza la especificación y crea un check por cada operación.

Para cada operación, LoadFocus construye:

• la URL de la petición a partir de servers de la especificación (OpenAPI 3) o schemes + host + basePath (Swagger 2), unida a la ruta de la operación;
• el método HTTP (GET, POST, PUT, PATCH, DELETE …);
• una comprobación de código de estado — el código de éxito documentado cuando la especificación lo declara, o si no «el estado es inferior a 400»;
• un nombre legible a partir del operationId de la operación (o MÉTODO /ruta).

Los parámetros de ruta como /users/{id} se rellenan con el valor example, default o el primero de enum del parámetro cuando la especificación lo proporciona, o con un marcador. Revisa esos checks tras la importación para que apunten a un recurso real.

Origen: pegar o URL

• Pegar — copia tu openapi.json, openapi.yaml, swagger.json o swagger.yaml en el cuadro. Se aceptan tanto JSON como YAML. Se admiten especificaciones de hasta unos megabytes.
• URL — indica la dirección pública de tu especificación (por ejemplo https://api.example.com/openapi.json). LoadFocus la carga por HTTPS. Las direcciones internas o privadas se rechazan.

URL base

LoadFocus lee la URL base de la especificación. Si la especificación no declara un servidor (o quieres apuntar los checks a otro sitio, como un host de staging), rellena Sustituir URL base — por ejemplo https://api.example.com.

Frecuencia y activación

• Frecuencia — con qué frecuencia se ejecuta cada check importado (5 minutos por defecto).
• Activar los checks importados — cuando está activado, los checks empiezan a ejecutarse de inmediato. Desactívalo para importarlos en pausa, revisarlos y activar solo los que quieras. Es útil cuando tu especificación contiene operaciones de escritura (POST, PUT, DELETE) que no quieres que un monitor programado llame repetidamente.

Qué revisar después de importar

• Operaciones de escritura — un monitor programado llama al endpoint en cada ejecución. Para POST / PUT / PATCH / DELETE, confirma que realmente quieres monitorizarlas, o impórtalas en pausa y activa solo las seguras.
• Parámetros de ruta — asegúrate de que los valores sustituidos apuntan a un recurso existente.
• Autenticación — los checks importados no tienen credenciales. Añade cabeceras, una clave de API o un token mediante secretos y variables para que los endpoints autenticados devuelvan su estado real.
• Cuerpos de petición — cuando la especificación incluye un cuerpo de ejemplo, se usa; en caso contrario, la petición se envía sin él.

Límites del plan

Los checks importados cuentan para el límite de monitores de API de tu plan, igual que los que creas a mano. Si una especificación tiene más operaciones que tu cuota restante, LoadFocus crea tantas como caben e informa de cuántas se crearon y cuántas se omitieron, de modo que no se crea nada en silencio por encima de tu plan.

Mantener los monitores sincronizados

Una importación puntual es una forma rápida de empezar. Si quieres que tus monitores se mantengan al día con la definición de tu API a lo largo del tiempo, gestiónalos como archivos versionados con Monitoring as Code y reconcílialos desde CI.