REST-Endpunkte für die Übertragung von APIs mit Push in IBM API Connect
Mit den REST-Endpunkt, der eine zentrale Position für lokale und Cloud-Liberty-Benutzer ist, können Sie APIs visualisieren, aufrufen und mit Push in IBM® API Connect übertragen.
Implementierte REST-Endpunkte mit Push in IBM API Connect übertragen
Um implementierte REST-Endpunkte mit Push in IBM API Connect zu übertragen, müssen Sie einen neuen REST-Endpunkt, /ibm/api/docs/apiconnect, aufrufen, der vom Feature apiDiscovery-1.0 in der Serverkonfiguration bereitgestellt wird. Administratoren und Entwickler können die REST-Endpunkte verwenden, um Assets aus einer Liberty-Instanz für jeden Unternehmensentwickler verfügbar zu machen, der die IBM API Connect-Frameworkkataloge durchsucht.
Produktdefinition bereitstellen
Alle APIs werden von einem Produkt referenziert und aus einem Katalog zur Verfügung gestellt. Deshalb stellt der Caller eine Produktdefinition bereit, die Liberty verwendet, um auf seine REST-konformen APIs zu verweisen und das entsprechende Produkt mit Push in IBM API Connect zu übertragen. Ein Beispielprodukt finden Sie in diesem Artikel.
Assets eines Liberty-Verbunds in IBM API Connect bereitstellen
Unter Verwendung eines entsprechenden Liberty-Verbundendpunkts, /ibm/api/collective/docs/apiconnect, können Sie alle Assets eines Liberty-Verbunds mit einem einzigen REST-konformen Auslöser in IBM API Connect verfügbar machen. Der Liberty-Verbundendpunkt kann Tausende von APIs für jeden Cloudentwickler, der mit API Connect verbunden ist, bereitstellen. Die vollständige Swaggger-Dokumentation dieses Endpunkts finden Sie in der Liberty-REST-API-Registry /ibm/api/explorer.
Endpunktzusammenfassung
HTTP-Anforderungsmethode: POST
URL: https://Server:HTTPS-Port/ibm/api/docs/apiconnect
Erforderliche Header
- X-APIM-Authorization
- Die Berechtigungen zum Herstellen der Verbindung zu API Connect werden in den folgenden beiden Formaten angezeigt:
- Benutzername und Kennwort
- xyz, wobei xyz für die Base64-codierte Version des Benutzernamens steht: Kennwort
Erforderliche Abfrageparameter
- Server
- Der Name des IBM API Connect-Servers mit dem Suffix https://.
- Katalog
- Der Name des Katalogs, der das entsprechende Produkt hostet.
- Organisation
- Der Name der Organisation des Callers.
Optionale Abfrageparameter
- apiRoot
- Ein Parameter mit mehreren Kardinalitäten, der exakt angibt, welche Kontextstammverzeichnisse, z. B. apiRoot=/myApp, der Caller mit Push in API Connect übertragen möchte. Liberty enthält standardmäßig alle implementierten Anwendungen mit Ausnahme bekannter Webanwendungsbundles der Liberty-Laufzeitumgebung. Dieser Parameter ist hilfreich, wenn Sie filtern möchten, welche Anwendungen bereitgestellt werden.
- Member-ID (nur für die Verbundvariante verfügbar)
- Ein Parameter mit mehreren Kardinalitäten, der die IDs der Verbundmember angibt, von denen der Caller Assets bereitstellen möchte. Diese IDs setzen sich aus einer Zeichenfolge mit dem Hostnamen, dem URLEncoded-Benutzerverzeichnis und dem Servernamen, alle durch Kommas voneinander getrennt, zusammen, z. B.: myHost.com, %2Ftmp%2Fwlp%2Fusr, server1.
- Eingabehauptteil
- Die Produktdefinition in YAML- oder JSON-Code. Sehen Sie sich das folgende YAML-Beispiel an:
product: "1.0.0" info: name: "pushed-product" title: "A Product that encapsulates Liberty APIs" version: "1.0.0" visibility: view: enabled: true type: "public" tags: - "string" orgs: - "string" subscribe: enabled: true type: "authenticated" tags: - "string" orgs: - "string" apis: liberty: name: "liberty-api:1.0.0" x-ibm-configuration: phase: "realized" testable: true enforced: true cors: enabled: true assembly: execute: - invoke: target-url: "${gateway.target}" title: "Invocation" description: "Invoking back-end service" plans: default: title: "Default Plan" rate-limit: hard-limit: false value: "100/hour" approval: false createdAt: "2016-04-18T20:33:22.937Z" createdBy: "string"