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.

Se aceptan tanto JSON como YAML. Los checks se crean en tu equipo activo y cuentan para los límites de tu plan, exactamente como si los hubieras creado a mano.

Cómo funciona

1. Abre API Monitoring y ve a la lista de checks.
2. Haz clic en Nuevo Monitor y elige después Importar OpenAPI en el grupo Synthetic.
3. Elige Pegar especificación y pega el texto de la especificación, o elige Desde URL e introduce una dirección que LoadFocus carga por ti.
4. Ajusta la Frecuencia, decide si Activar los checks importados ahora está marcado y rellena Sobrescribir URL base solo si tu especificación no tiene servidor.
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, HEAD u OPTIONS);
• una comprobación de código de estado: el primer código de éxito 2xx documentado cuando la especificación lo declara, o si no una comprobación de que el código de 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. Si no, se usa 1 para los parámetros enteros y numéricos y el texto example para el resto. Revisa esos checks tras la importación para que apunten a un recurso real.

Cada check importado se ejecuta desde una ubicación, US East (N. Virginia). Edita un check después si quieres más ubicaciones.

Origen: pegar o URL

• Pegar especificación: copia el contenido de tu openapi.json, openapi.yaml, swagger.json o swagger.yaml en el cuadro. Una especificación puede pesar hasta unos 5 MB y describir hasta 500 operaciones.
• Desde URL: introduce la dirección pública de tu especificación (por ejemplo https://api.example.com/openapi.json). La dirección debe empezar por https://, no se siguen las redirecciones y se rechazan las direcciones internas o privadas. Se aplica el mismo límite de tamaño.

URL base

LoadFocus lee la URL base de la especificación: la primera entrada de servers en OpenAPI 3, o schemes, host y basePath en Swagger 2. Si la especificación no declara ninguna (o su primer servidor es una ruta relativa), rellena Sobrescribir URL base, por ejemplo https://api.example.com. La sustitución es solo un recurso de reserva: cuando la especificación tiene un servidor utilizable, se usa ese y se ignora la sustitución. Para importar contra un host de staging, ponlo el primero en la lista servers de la especificación.

Frecuencia y activación

• Frecuencia: con qué frecuencia se ejecuta cada check importado. Elige 5, 10, 15 o 30 minutos, o 1 hora; 5 minutos es el valor por defecto.
• Activar (Activar los checks importados ahora): cuando está marcado, los checks empiezan a ejecutarse de inmediato. Desmárcalo 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 y 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 ninguna cabecera. Añade las cabeceras que necesite tu API, como una clave de API o un token, mediante variables y secretos para que los endpoints autenticados devuelvan su estado real.
• Cuerpos de petición: en una operación de OpenAPI 3 cuyo cuerpo de petición tiene un ejemplo, ese ejemplo se envía como cuerpo. En todos los demás casos, incluidas todas las operaciones de Swagger 2, la petición se envía sin cuerpo.

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.