Importer depuis OpenAPI / Swagger

Si vous décrivez déjà votre API avec une spécification OpenAPI 3.x ou Swagger 2.0, vous n'avez pas à recréer chaque endpoint à la main dans LoadFocus. Importez la spécification et LoadFocus génère un moniteur d'API par opération — méthode, URL et une assertion de code de statut — en une seule étape.

Cela fonctionne avec OpenAPI 3.x et Swagger 2.0, en JSON ou YAML, et s'exécute entièrement dans votre compte et votre équipe active, avec les limites de votre offre appliquées exactement comme dans le tableau de bord.

Comment ça marche

1. Ouvrez API Monitoring et accédez à la liste des checks.
2. Cliquez sur Importer depuis OpenAPI.
3. Soit vous collez le texte de la spécification, soit vous indiquez une URL que LoadFocus récupère pour vous.
4. Choisissez la fréquence et si les checks importés démarrent actifs.
5. Cliquez sur Importer. LoadFocus analyse la spécification et crée un check pour chaque opération.

Pour chaque opération, LoadFocus construit :

• l'URL de la requête à partir des servers de la spécification (OpenAPI 3) ou de schemes + host + basePath (Swagger 2), jointe au chemin de l'opération ;
• la méthode HTTP (GET, POST, PUT, PATCH, DELETE …) ;
• une assertion de code de statut — le code de succès documenté lorsque la spécification en déclare un, sinon « le statut est inférieur à 400 » ;
• un nom lisible à partir de l'operationId de l'opération (ou MÉTHODE /chemin).

Les paramètres de chemin comme /users/{id} sont remplis avec la valeur example, default ou la première valeur enum du paramètre lorsque la spécification en fournit une, sinon avec un espace réservé. Vérifiez ces checks après l'import pour qu'ils pointent vers une ressource réelle.

Source : coller ou URL

• Coller — copiez votre openapi.json, openapi.yaml, swagger.json ou swagger.yaml dans le champ. JSON et YAML sont tous deux acceptés. Les spécifications jusqu'à quelques mégaoctets sont prises en charge.
• URL — indiquez l'adresse publique de votre spécification (par exemple https://api.example.com/openapi.json). LoadFocus la récupère en HTTPS. Les adresses internes ou privées sont refusées.

URL de base

LoadFocus lit l'URL de base depuis la spécification. Si la spécification ne déclare pas de serveur (ou si vous voulez diriger les checks ailleurs, par exemple vers un hôte de préproduction), renseignez Remplacer l'URL de base — par exemple https://api.example.com.

Fréquence et activation

• Fréquence — à quelle fréquence chaque check importé s'exécute (5 minutes par défaut).
• Activer les checks importés — lorsqu'elle est activée, les checks démarrent immédiatement. Désactivez-la pour les importer en pause, les vérifier et n'activer que ceux que vous voulez. C'est utile lorsque votre spécification contient des opérations d'écriture (POST, PUT, DELETE) qu'un moniteur planifié ne doit pas appeler de façon répétée.

Ce qu'il faut vérifier après l'import

• Opérations d'écriture — un moniteur planifié appelle l'endpoint à chaque exécution. Pour POST / PUT / PATCH / DELETE, confirmez que vous voulez vraiment les surveiller, ou importez en pause et n'activez que celles qui sont sûres.
• Paramètres de chemin — assurez-vous que les valeurs substituées pointent vers une ressource existante.
• Authentification — les checks importés n'ont pas d'identifiants. Ajoutez des en-têtes, une clé d'API ou un jeton via les secrets et variables pour que les endpoints authentifiés renvoient leur véritable statut.
• Corps de requête — lorsque la spécification inclut un corps d'exemple, il est utilisé ; sinon, la requête est envoyée sans corps.

Limites de l'offre

Les checks importés comptent dans la limite de moniteurs d'API de votre offre, comme les checks que vous créez à la main. Si une spécification comporte plus d'opérations que votre quota restant, LoadFocus en crée autant que possible et indique combien ont été créés et combien ont été ignorés, de sorte que rien n'est créé silencieusement au-delà de votre offre.

Garder les moniteurs synchronisés

Un import ponctuel est un moyen rapide de démarrer. Si vous voulez que vos moniteurs restent alignés avec la définition de votre API au fil du temps, gérez-les comme des fichiers versionnés avec Monitoring as Code et réconciliez-les depuis la CI.