REST-API-Definitionsdatei publizieren

Sie können ein Webprojekt auf einem Liberty-Server implementieren. Sie können die veröffentlichte API-Definitionsdatei (Application Programming Interface, Anwendungsprogrammierschnittstelle) in einem Web-Browser anzeigen.

Vorbereitende Schritte

Geben Sie Ihre REST-API an, indem Sie eine Datei vom Typ swagger.json erstellen. Weitere Informationen zum Erstellen einer Datei vom Typ swagger.json finden Sie unter REST-API-Definitionsdatei erstellen.

Informationen zu diesem Vorgang

Wichtig: Gilt für Liberty, Liberty Core

Vorgehensweise

  1. Konfigurieren Sie die Datei server.xml so, dass die Laufzeitumgebung die Datei swagger.json suchen kann.

    Weitere Informationen zum Konfigurieren der Datei server.xml finden Sie unter Konfigurationsinformationen aus externen xml-Dateien in die Datei server.xml aufnehmen.

  2. Starten Sie den Liberty-Server.

    Weitere Informationen zum Starten eines Liberty-Servers finden Sie unter Server mit Entwicklertools starten und stoppen.

  3. Klicken Sie in der Ansicht Server mit der rechten Maustaste auf den Liberty-Server und wählen Sie Hinzufügen und entfernen aus.
  4. Wählen Sie Ihr Webprojekt aus, klicken Sie auf Hinzufügen und anschließend auf Fertigstellen.
  5. Öffnen Sie ein Browserfenster und geben Sie https://localhost:9443/ibm/api/explorer/ ein, um die REST-API-Definitionsdatei anzuzeigen.
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_restapi_publish.html