Quelles sont les informations reprises de mon API Pull Open API ?

Modifié le Lun, 17 Mars, 2025 à 6:01 H

A partir du moment où le fichier OpenAPI importé est valide, l’API spécifiée par le fichier est ajoutée à l’offre de données que vous êtes en train de compléter. Une première version de cette API est automatiquement créée, avec un statut brouillon.

Cette version reprend toutes les informations contenues dans le fichier OpenAPI :

le nom de l’API
sa version
sa base URL
sa documentation description, liens, contact technique…
la liste de ses endpoints organisés en collections

Selon le taux de complétion du fichier importé, la version peut être en statut de :

configuration incomplète : la base URL est manquante ou au mauvais format
configuration complète

Vous pouvez consulter le détail de chaque endpoint spécifié dans le fichier OpenAPI en cliquant dessus.

Selon les informations définies dans le fichier, vous pouvez consulter :

la description du endpoint, courte et détaillée
un exemple de requête
le schéma de la requête à envoyer
la liste des codes de réponse, avec pour chacun un exemple de réponse et le schéma de la réponse