Vous pouvez utiliser un assistant pour générer un fichier de modèle swagger.json spécifiant une interface de programmation (API)
REST (Representational State Transfer). L'assistant est activé pour les projets ciblant un serveur Liberty et utilisant Web 2.5 et versions ultérieures.
Pourquoi et quand exécuter cette tâche
Important : Applicable à Liberty, Liberty Core
Procédure
- Créez un projet Web ciblant un serveur Liberty.
Pour plus d'informations sur la création de projets Web; voir
Création de projets Web.
- Pour créer un fichier de définition d'API REST Swagger, suivez l'une des options ci-dessous :
- Sélectionnez , puis Swagger REST API definition file dans la section sur la définition d'API REST.
- Cliquez avec le bouton droit de la souris sur un projet et sélectionnez .
- Sélectionnez le type de fichier JSON (JavaScript Object Notation) à créer :
- Pour créer un fichier avec tous les éléments Swagger de premier niveau requis, sélectionnez
Create a swagger.json template file.
- Pour créer un fichier avec un échantillon de contenu pour les définitions communes, telles que
GET, PUT et POST, sélectionnez Create a swagger.json sample
file.
- Sélectionnez un emplacement pour le fichier que vous créez :
- Cliquez sur Terminer.
Résultats
Les outils génèrent un fichier swagger.json sous le répertoire
WebContent/META-INF de votre projet Web. Le fichier s'ouvre dans votre éditeur
JSON par défaut.