Wenn Sie bereits über einen in „ OpenAPI “ beschriebenen Zielservice verfügen, den Sie über eine „ IBM® API Connect “-API-Definition verfügbar machen möchten, können Sie eine Proxy-API erstellen und den Ziel-Endpunkt angeben.
Informationen zu dieser Task
Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen.
Um diese Task auszuführen, muss Ihnen eine Rolle
zugeordnet sein, die über die Berechtigungen Api-Drafts:Edit, Settings:View und
App:View verfügt. Die vorab bereitgestellte Entwicklerrolle weist diese
Berechtigungen standardmäßig auf; wenn Ihnen eine angepasste Rolle zugeordnet wird, muss sie über diese Berechtigungen verfügen. Weitere Informationen finden Sie unter Angepasste Rollen erstellen.
Erstellen Sie innerhalb von Minuten Proxy-REST-APIs, indem Sie mit dem Tool API Designer eine -API aus einem vorhandenen OpenAPI -Serviceerstellen. Bei dieser Prozedur wird ein REST-Proxy erstellt, der den gesamten Datenverkehr an eine Ziel-REST-API oder einen Serviceendpunkt weiterleitet.
Vorgehensweise
Gehen Sie wie folgt vor, um eine Proxy-API aus einem vorhandenen OpenAPI-Service zu erstellen.
- Klicken Sie im Navigationsbereich
Entwickeln, dann auf klicken.Die Anzeige API-Typ auswählen wird angezeigt.
- Wählen Sie OpenAPI 2.0 oder OpenAPI 3.0 aus, je nachdem, auf welcher Version der OpenAPI -Spezifikation Ihre API basieren soll.
- Wählen Sie Aus vorhandenem OpenAPI -Serviceaus und klicken auf Weiter.
- Um die Serviceinformationen aus einer OpenAPI-Datei hochzuladen, können Sie entweder Ihre Datei ziehen und ablegen oder die Datei, die Sie verwenden möchten, suchen und auswählen. Gültige Dateitypen sind YAML, YML usw.
- Klicken Sie auf Durchsuchen und suchen Sie die OpenAPI-Datei.
- Ziehen Sie die Datei per Drag and Drop in den aktiven Bereich.
Nachdem Sie die Datei hochgeladen haben, wird die OpenAPI-Spezifikation ausgewertet und eine Nachricht zeigt an, ob sie gültig ist.
- Klicken Sie auf Weiter. Geben Sie die API-Zusammenfassung im Abschnitt Info an. Sie können die API nach dem Erstellen optimieren.
- Der Titel kann Sonderzeichen enthalten, sollte aber kurz gehalten werden, sodass er
leicht in der Benutzerschnittstelle angezeigt werden kann.
- Der Name wird automatisch eingegeben. Der Wert im Feld Name ist eine einzelne Zeichenfolge, die zum Identifizieren der API in Entwicklertoolkit -CLI-Befehlen verwendet wird. Die CLI-Befehle zur Verwaltung von API-Entwürfen finden Sie in der Referenzdokumentation zur Toolkit-CLI.
- Die Version entspricht dem Wert der Eigenschaft
info.version der API-Definition OpenAPI . Das Versionsnummerierungsschema version.release.modification wird empfohlen, z. B. 1.0.0.
- Der Basispfad ist das URL-Segment der API und schließt weder
den Hostnamen noch weitere Segmente für Pfade oder Operationen ein. Der Basispfad darf
keine Sonderzeichen enthalten und muss mit dem Zeichen
/
beginnen, auch wenn er ansonsten leer ist.
- Mit der optionalen Beschreibung können Sie die API identifizieren.
- Klicken Sie auf Weiter. Konfigurieren Sie im Abschnitt
Sichern die API-Sicherheit, die Sie benötigen.
- Mit Client-ID sichern - Wählen Sie diese Option aus, um
erforderlich zu machen, dass eine Anwendung eine Client-ID (API-Schlüssel) bereitstellt. Dadurch wird der Parameter
X-IBM-Client-Id in den Anforderungsheader für die API eingeschlossen. Wird er ausgewählt, können Sie dann auswählen, ob die API-Aufrufe auf Schlüsselbasis (pro Client-ID) begrenzt werden sollen:
- API-Aufrufe auf Schlüsselbasis begrenzen - Ist diese Option
ausgewählt, müssen Sie die erforderliche Ratenbegrenzung konfigurieren. Ratenbegrenzungen
steuern die maximal zulässige Anzahl an Aufrufen innerhalb eines bestimmten Zeitraums
(Stunde, Minute, Monat oder Tag). Beispiel: 100 Aufrufe pro Stunde.
- CORS - Wählen Sie diese Option aus, um CORS-Unterstützung (CORS - Cross-Origin Resource Sharing) für Ihre API zu aktivieren. Auf diese Weise kann die API von einer anderen Domäne aus aufgerufen werden.
Hinweis:
- CORS Support ist nur auf der DataPower® API Gateway. verfügbar.
- Wenn CORS aktiviert ist, führt das API-Gateway die
cors -Preflow-Richtlinie aus, um alle CORS-Anforderungen
zu verarbeiten, die an die API gesendet werden.
- Wenn CORS aktiviert ist und eine Preflight-Anforderung empfangen wird, werden nur die folgenden API-Aktionen ausgeführt:
- Die Preflow-Richtlinie
cors konfiguriert die entsprechenden Antwortheader.
- Die Antwortheader werden festgelegt.
- Wenn eine Preflight-Anforderung empfangen wird, wird das
request.attributes.isCORSPreflight -Flag auf
truegesetzt.
- Bei allen Preflight-Anforderungen werden die Preflow-Richtlinien von
security und
client-identification immer übersprungen, unabhängig davon, ob CORS aktiviert oder nicht aktiviert ist.
- Optional: Wählen Sie „API aktivieren“, wenn Sie die API sofort für die weitere Entwicklung und für Tests nutzen möchten.
Hinweis:
- Wenn Sie die Option API aktivieren auswählen, führt API Connect automatisch die folgenden Aktionen aus:
- Erstellt einen Entwurfsprodukt, fügt die API zum Produkt hinzu und veröffentlicht das
Produkt im Sandbox-Katalog, sodass die API aufgerufen werden kann. Das Produkt hat den
Titel api_title auto product. Dieses Produkt ist in der Ansicht
Entwickeln nicht sichtbar und kann nicht direkt gelöscht werden. Wenn Sie die API jedoch löschen, wird der Produktentwurf zusammen mit der API gelöscht; siehe „Eine API-Definition löschen “. Das Produkt ist in
allen Katalogen sichtbar, für die es veröffentlicht wurde. Wenn Sie das Produkt aus einem Katalog entfernen möchten, müssen Sie dies separat vornehmen; siehe „Ein Produkt aus einem Katalog entfernen“
- Abonniert die Sandbox-Testanwendung für das Produkt, sodass Sie die API sofort in der Testumgebung testen können. Informationen zum Testen einer API finden Sie unter Testen einer API.
- Sie können die Option „Activate API“ nicht verwenden, wenn im Sandbox-Katalog für die Aktionen „Stage“, „Publish“ oder „Replace“ die Lebenszyklusgenehmigung aktiviert ist. Wenn solche Lebenszyklus-Genehmigungen aktiviert sind, müssen sie deaktiviert werden, damit die Option „Activate API“ genutzt werden kann; Informationen zu den Einstellungen für Lebenszyklus-Genehmigungen finden Sie unter „Kataloge erstellen und konfigurieren “.
- Um die Option API aktivieren verwenden zu können, muss Ihnen eine Rolle mit den Berechtigungen
Product:Manage und Subscription:Manage zugewiesen sein. Die vorab bereitgestellte Entwicklerrolle weist diese
Berechtigungen standardmäßig auf; wenn Ihnen eine angepasste Rolle zugeordnet wird, muss sie über diese Berechtigungen verfügen. Weitere Informationen finden Sie unter Angepasste Rollen erstellen.
- Klicken Sie auf Weiter , um Ihre API-Definition zu erstellen.
In der Zusammenfassungsanzeige werden Nachrichten angezeigt, während die Definition
erstellt wird, und die ausgewählten Sicherheitsoptionen und Ratenbegrenzungen werden
erzwungen.
Wenn Sie "API aktivieren" ausgewählt haben, füllt der Assistent einen API-Endpunkt URL aus, den Sie zum Testen verwenden können. Wenn Sie auch Mit Client-ID sichern ausgewählt
haben, zeigt der Assistent eine Client-ID und einen geheimen Clientschlüssel an,
die Sie
verwenden können.
- Wählen Sie eine der folgenden Optionen aus:
- Um die API weiter zu konfigurieren, klicken Sie auf API
bearbeiten. Details finden Sie unter Bearbeiten einer API-Definition.
- Wenn Sie Ihre API zu diesem Zeitpunkt nicht weiter konfigurieren möchten, klicken Sie auf den Link Entwickeln im Navigationspfad, um zur Begrüßungsseite zurückzukehren. Sie können anschließend sofort mit einer anderen Task fortfahren. Details zur späteren Konfiguration Ihrer API finden Sie unter Bearbeiten einer API-Definition.
Ergebnisse
Sie haben eine Proxy-API aus einem vorhandenen OpenAPI-Service erstellt.
Nächste Schritte
APIs werden für Anwendungsentwickler verfügbar gemacht, indem Sie sie in ein Produkt
einschließen und dieses Produkt anschließend in einem Katalog veröffentlichen. Weitere Informationen finden Sie unter „Arbeiten mit Produkten “ und „Arbeiten mit Katalogen “.