Création d'un fichier de définition d'API REST

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

  1. 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.

  2. Pour créer un fichier de définition d'API REST Swagger, suivez l'une des options ci-dessous :
    • Sélectionnez Fichier > Nouveau > Autre, 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 New > Swagger REST API definition file.
  3. 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.
  4. Sélectionnez un emplacement pour le fichier que vous créez :
    • Pour utiliser des annotations Swagger, sélectionnez Generate as stub document (META-INF/stub directory).
    • Si vous n'utilisez pas les annotations Swagger, sélectionnez Generate as top level document (META-INF directory).
      Remarque : Cette option est sélectionnée par défaut.
  5. 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.

Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_restapi_create.html