REST API Erkennung

Dokumentation für REST API ist im IBM® Documentation und im Swagger-Format verfügbar. Swagger ist eine gängige Methode zur Dokumentation von REST-APIs. Die Swagger-Dokumentation für REST API kann angezeigt werden, indem die API-Erkennungsfunktion (apiDiscovery) auf dem mqweb-Server aktiviert wird.

Vorbereitungen

Wichtig: Das Feature apiDiscovery wurde stabilisiert. Sie können diese Funktion weiterhin nutzen. Derzeit unterstützt IBM MQ die Verwendung des Features mpOpenAPI nicht.

Sie müssen die Sicherheit für den mqweb-Server aktivieren, um die Swagger-Dokumentation mithilfe der API-Erkennung anzeigen zu können. Weitere Informationen zu den Schritten, die zum Aktivieren der Sicherheit erforderlich sind, finden Sie unter IBM MQ Console und REST API Sicherheit.

Verfahren

Suchen Sie die Datei mqwebuser.xml in einem der folgenden Verzeichnisse:
- MQ_DATA_PATH/web/installations/installationName/servers/mqweb
- WLP_user_directory/servers/mqweb
  Dabei ist WLP_user_directory das Verzeichnis, das angegeben wurde, als das Script crtmqweb ausgeführt wurde, um die mqweb-Serverdefinition zu erstellen.
Fügen Sie die entsprechende XML zur Datei mqwebuser.xml hinzu:
- Wenn die <featureManager> -Tags in Ihrer mqwebuser.xml -Datei vorhanden sind, fügen Sie die folgende XML innerhalb der <featureManager> -Tags hinzu:
  <feature>apiDiscovery-1.0</feature>
- Wenn die <featureManager> -Tags in Ihrer mqwebuser.xml -Datei nicht vorhanden sind, fügen Sie die folgende XML innerhalb der <server> -Tags hinzu:
```
<featureManager>
     <feature>apiDiscovery-1.0</feature>
</featureManager>
```
Zeigen Sie die Swagger-Dokumentation an, indem Sie eine der folgenden Methoden verwenden:
- Rufen Sie eine Webseite auf, auf der Sie REST API durchsuchen und ausprobieren können, indem Sie Folgendes in einen Browser eingeben: URL
  https://host:port/ibm/api/explorer
  
  Zusätzlich zur Authentifizierung jeder Anforderung müssen Sie einen ibm-mq-rest-csrf-token -Header für jede POST-, PATCH-oder DELETE-Anforderung einschließen. Der Inhalt dieses Headers kann eine beliebige Zeichenfolge sein, einschließlich leer.
  
  Dieser Anforderungsheader wird verwendet, um zu bestätigen, dass die Berechtigungsnachweise, die zur Authentifizierung der Anforderung verwendet werden, von dem Eigner der Berechtigungsnachweise verwendet werden. Dies bedeutet, dass das Token verwendet wird, um Cross-Site-Request-Forgery-Attacken zu verhindern.
- Rufen Sie ein einzelnes Swagger 2-Dokument ab, das die gesamte REST API beschreibt, indem Sie einen HTTP GET an die folgende URL senden:
  https://host:port/ibm/api/docs
  
  Dieses Dokument kann für Anwendungen verwendet werden, in denen Sie programmgesteuert in den verfügbaren APIs navigieren möchten.
host

Gibt den Hostnamen oder die IP-Adresse an, auf dem bzw. der REST API verfügbar ist.

Der Standardwert ist localhost.

port

Gibt HTTPS an, die administrative REST API verwendet.

Der Standardwert ist 9443.

Wenn der Hostname oder die Portnummer von den Standardwerten abweichen, können Sie die korrekten Werte unter REST API URL ermitteln. Verwenden Sie den Befehl dspmqweb status, um URL anzuzeigen.