REST-API-Definitionsdatei erstellen

Sie können einen Assistenten zum Erstellen einer Schablonendatei vom Typ swagger.json verwenden, um eine REST-API anzugeben. Der Assistent ist für Projekte für Liberty-Server, die Web 2.5 oder höher verwenden, aktiviert.

Informationen zu diesem Vorgang

Wichtig: Gilt für Liberty, Liberty Core

Vorgehensweise

  1. Erstellen Sie ein Webprojekt für einen Liberty-Server.

    Weitere Informationen zum Erstellen von Webprojekten finden Sie unter Webprojekte erstellen.

  2. Führen Sie einen der folgenden Schritte aus, um eine Swagger-REST-API-Definitionsdatei zu erstellen.
    • Klicken Sie auf Datei > Neu > Andere und wählen Sie dann Swagger-REST-API-Definitionsdatei im Abschnitt REST-API-Definition aus.
    • Klicken Sie mit der rechten Maustaste auf ein Projekt und wählen Sie Neu > Swagger-REST-API-Definitionsdatei aus.
  3. Gehen Sie wie folgt vor, um den Typ der zu erstellenden JSON-Datei (JavaScript Object Notation) auszuwählen:
    • Wenn Sie eine Datei mit allen erforderlichen Swagger-Elementen der höchsten Ebene erstellen möchten, wählen Sie Schablonendatei swagger.json erstellen aus.
    • Wenn Sie eine Datei mit Beispielinhalt für allgemeine Definitionen erstellen möchten, wie z. B. GET, PUT und POST, wählen Sie Beispieldatei swagger.json erstellen aus.
  4. Wählen Sie eine Position für die zu erstellende Datei aus:
    • Wenn Sie mit Swagger-Annotationen arbeiten, wählen Sie Als Stubdokument generieren (META-INF/stub-Verzeichnis) aus.
    • Wenn Sie nicht mit Swagger-Annotationen arbeiten, wählen Sie Als Dokument der Ausgangsebene generieren (META-INF-Verzeichnis) aus.
      Anmerkung: Diese Option ist standardmäßig ausgewählt.
  5. Klicken Sie auf Fertigstellen.

Ergebnisse

Die Tools generieren eine Datei vom Typ swagger.json im Ordner WebContent/META-INF für Ihr Webprojekt. Die Datei wird in Ihrem JSON-Standardeditor geöffnet.

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

File name: t_restapi_create.html