TypeScript API-Clients kompilieren
Nachdem Sie ein API-Plugin erstellt haben, müssen Sie einen entsprechenden TypeScript API-Client kompilieren.
Um einen TypeScript API-Client zu kompilieren
-
Öffnen Sie ein Kommandozeilenprogramm.
-
Führen Sie folgenden Befehl aus:
imxclient compile-api -N -W /copyapi imx-api-ccc.tgz /packagename imx-api-ccc
Das Dialogfenster zum Auswählen der Datenbankverbindung öffnet sich.
-
Im Dialogfenster nehmen Sie eine der folgenden Aktionen vor:
-
Um eine bestehende Verbindung zur One Identity Manager-Datenbank zu verwenden, wählen Sie aus der Auswahlliste Datenbankverbindung auswählen die entsprechende Verbindung aus.
- ODER -
-
Um eine neue Verbindung zur One Identity Manager-Datenbank zu verwenden, klicken Sie Neue Verbindung erstellen und geben Sie eine neue Verbindung an.
-
Unter Authentifizierungsverfahren geben Sie das Verfahren und die Anmeldedaten an, mit denen Sie sich an der Datenbank anmelden möchten.
-
Klicken Sie Anmelden.
-
Importieren Sie das npm-Paket imx-api-ccc in Ihre TypeScript-Anwendung.
Der API Designer
Mit dem API Designer können Sie auf schnellstem Wege eine REST-API (Representational State Transfer Application Programming Interface) erstellen, dokumentieren, kompilieren und veröffentlichen. Diese API basiert auf der OpenAPI-Spezifikation und dem One Identity Manager-Datenbankmodell.
Vorteile des API Designers auf einem Blick:
-
Einfache und schnelle Bedienung
-
Die fertige API "versteht" das One Identity Manager-Datenbankmodell.
-
Änderungen an der API sind nachvollziehbar.
-
Unterstützt Prinzipien eines guten API-Designs
-
OpenAPI-Unterstützung: APIs, die Sie mithilfe des API Designers erstellen, basieren grundsätzlich auf der OpenAPI-Spezifikation. Dies ermöglicht Ihnen auf weitere Hilfsmittel zuzugreifen:
- Swagger: Verwenden Sie Swagger, um Code, Dokumentation und Testfälle zu erstellen.
- Postman: Verwenden Sie Postman, um die verschiedenen API-Methoden Ihrer API zu testen.
Schnellstart – Eine API mit dem API Designer erstellen
Schnellstart – Eine API mit dem API Designer erstellen
HINWEIS: One Identity empfiehlt APIs nicht mithilfe des API Designers zu erstellen und zu implementieren, sondern stattdessen als API-Plugin (siehe Eigene APIs implementieren).
Nachfolgend finden Sie eine grobe Auflistung der Schritte, die Sie im API Designer durchführen müssen, um eine API zu erstellen.
-
Starten Sie den API Designer.
-
Erstellen Sie API-Dateien (in diesen können Sie beispielsweise eine API-Methode definieren).
-
Erstellen Sie ein API-Projekt oder bearbeiten Sie ein bestehendes (beispielsweise von One Identity mitgeliefertes) Projekt, um die bereits vorhandenen Funktionen zu nutzen und Ihren eigenen Wünschen anzupassen.
-
Konfigurieren Sie die Authentifizierung des API-Projektes (beispielsweise Single Sign-on).
HINWEIS: Wenn Sie ein bestehendes von One Identity mitgeliefertes API-Projekt bearbeiten, können Sie die Authentifizierung nicht mehr ändern.
-
Weisen Sie die erstellten API-Dateien dem API-Projekt zu.
-
Testen Sie die API.
-
Kompilieren Sie die API.
-
Übertragen Sie die Änderungen in die Datenbank.
Verwandte Themen
Arbeiten mit dem API Designer
Arbeiten mit dem API Designer
In diesem Kapitel finden Sie Informationen zur allgemeinen Arbeit mit dem API Designer.
Erfahren Sie hier unter anderem:
