Contrats d'API
Depuis Talend Cloud API Designer
Talend Cloud API Designer est un module de la plateforme Talend qui permet aux équipes de concevoir et de documenter leurs contrats d'API. Talend propose une intégration intégrée de Talend Cloud API Designer vers Talend Cloud API Tester pour interagir rapidement avec l'API en cours de construction. Le contrat importé peut également se révéler utile pour effectuer un bootstrap sur les tests d'API à partir d'un contrat existant.
Swagger 2.0
La spécification du format Swagger 2.0 est disponible dans le dépôt OpenAPI-Specification sur GitHub.
Seul JSON est supporté pour le moment. Avec un document YAML, vous pouvez facilement le convertir en JSON avant de l'importer dans Talend Cloud API Tester. Vous pouvez tester le convertisseur en ligne JSON to YAML (en anglais), par exemple.
La description Swagger complète est importée dans un nouveau projet. La table ci-dessous décrit les éléments créés lors de l'import.
| Élément Swagger | Élément correspondant de Talend Cloud API Tester | Commentaires |
|---|---|---|
| API | Project | Un projet contenant tout le Swagger converti. Son nom et sa description sont le titre et la description de l'API Swagger. |
| Path | Service | Chaque chemin dans Swagger est converti en un service. Le service est nommé d'après le chemin de base du chemin Swagger. |
| Operation | Request | Toutes les opérations d'un chemin Swagger sont converties en des requêtes et localisées dans le service extrait de ce chemin. |