API-Client-Generierung mit Swagger Codegen

Generieren Sie REST-API-Clients mit Swagger Codegen für Java oder Python, um Ihre FactFinder-Integration zu beschleunigen.

Swagger Codegen kann Client-Code für viele Programmiersprachen generieren, darunter Java, Python, JavaScript, Lua und PHP. Mehr erfahren Sie hier: https://swagger.io/tools/swagger-codegen/

Wie man mit Swagger Codegen 2 Java-Code generiert

1) Klonen Sie das Swagger-Codegen-Repository:

git clone https://github.com/swagger-api/swagger-codegen

Installieren Sie bei Bedarf zuerst Git.

2) Wechseln Sie in das Repository:

cd swagger-codegen

3) Erstellen Sie das Projekt:

mvn clean package

Falls erforderlich, installieren Sie zuerst eine aktuelle Java-Version und Apache Maven.

4) Erstellen Sie ein Ausgabeverzeichnis:

mkdir ffng-java-client

Sie können einen beliebigen Verzeichnisnamen wählen. Der Einfachheit halber verwendet diese Anleitung ffng-java-client.

5) Öffnen Sie https://[Ihre FactFinder-Einrichtung hier]/Fact-Finder/swagger-ui.html in Ihrem Browser und kopieren Sie den angezeigten Swagger-Link aus der Kopfzeile der Seite. Im folgenden Screenshot lautet der verlinkte Text ./rest/v5/swagger. Verwenden Sie nicht die ungültige URL, die im Screenshot angezeigt wird.

Dann ausführen:

java -jar Module/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i [your swagger-link here] -l java -o ./ffng-java-client

Dies generiert Beispiel-Client-Code für alle von FactFinder unterstützten Anfragetypen.

6) Wechseln Sie in das generierte Client-Verzeichnis:

cd ffng-java-client

7) Kopieren Sie die Suche mit POST Beispiel aus ffng-java-client/docs/SearchApi.md in eine Java-Quelldatei, zum Beispiel src/main/java/examplecompany/ExampleSearchClient.java. Fügen Sie die fehlenden Teile hinzu, wie zum Beispiel package examplecompany; und public class ExampleSearchClient {.

Machen Sie die in Schritt 5 generierten Klassen in Ihrem Projekt-Klassenpfad verfügbar.

8a) Geben Sie die richtigen Anmeldedaten in der basicAuth Sektion ein und entfernen Sie den OAuth2 Abschnitt.

8b) Legen Sie den korrekten FactFinder-Kanalnamen fest.

8c) Fügen Sie diesen oder einen ähnlichen Codeausschnitt ein, um die Suchanfrage festzulegen:

SearchParams searchParams= new SearchParams();
searchParams.setQuery("*");
searchRequest.setParams(searchParams);

9) Erstellen Sie den Client:

mvn clean install

10) Führen Sie Ihren ersten Beispiel-Suchclient aus. Da Maven zum Erstellen des Projekts verwendet wurde, ist es eine einfache Option, ihn ebenfalls mit Maven zu starten: mvn exec:java -Dexec.mainClass=examplecompany.ExampleSearchClient

Verwenden Sie mvn exec:java -D"exec.mainClass"=examplecompany.ExampleSearchClient wenn Sie verwenden Windows PowerShell.

Alle anderen Anfragen können auf ähnliche Weise erstellt werden. Codebeispiele dafür finden Sie in den Markdown-Dateien in der generierten Dokumente Ordner.

Wie man Python-Code mit Swagger Codegen 2 generiert

1) Klonen Sie das Swagger-Codegen-Repository:

git clone https://github.com/swagger-api/swagger-codegen

Installieren Sie bei Bedarf zuerst Git.

2) Wechseln Sie in das Repository:

cd swagger-codegen

3) Erstellen Sie das Projekt:

mvn clean package

Falls erforderlich, installieren Sie zuerst eine aktuelle Java-Version und Apache Maven.

4) Erstellen Sie ein Ausgabeverzeichnis:

mkdir ffng-python-client

5) Öffnen Sie https://[Ihre FactFinder-Einrichtung hier]/Fact-Finder/swagger-ui.html in Ihrem Browser und kopieren Sie den angezeigten Swagger-Link aus der Kopfzeile der Seite. Im folgenden Screenshot lautet der verlinkte Text ./rest/v5/swagger. Verwenden Sie nicht die ungültige URL, die im Screenshot angezeigt wird.

Dann ausführen:

java -jar Module/swagger-codegen-cli/target/swagger-codegen-cli.jar generieren -i [Ihr swagger-link hier] -l python -o ./ffng-python-client

Dies generiert Beispiel-Client-Code für alle von FactFinder unterstützten Anfragetypen.

6) Wechseln Sie in das generierte Client-Verzeichnis:

cd ffng-python-client

7) Kopieren Sie die Suche mit POST Beispiel aus ffng-python-client/docs/SearchApi.md in eine Python-Quelldatei, zum Beispiel my-example-search-client.py.

8a) Fügen Sie den folgenden Python-Code in Ihre Datei ein:

class MyConfiguration(swagger_client.Configuration):
 def auth_settings(self):
 return {
 'basicAuth':
 {
 'type': 'basic',
 'in': 'header',
 'key': 'Authorization',
 'value': self.get_basic_auth_token()
 }
 }

8b) Ersetzen Sie die Zeile:

configuration = swagger_client.Configuration()

durch die Zeile:

configuration = MyConfiguration()

9a) Geben Sie die korrekten Anmeldedaten in den basicAuth Sektion ein und entfernen Sie den OAuth2 Abschnitt.

9b) Legen Sie den richtigen FactFinder-Kanalnamen fest.

9c) Fügen Sie diesen oder einen ähnlichen Codeausschnitt ein, um die Suchanfrage festzulegen, indem Sie diese Zeile ersetzen:

search_request = swagger_client.SearchRequest()

mit diesen drei Zeilen:

query = "*"
search_params = swagger_client.SearchParams(query=query)
search_request = swagger_client.SearchRequest(search_params)

1. Starten Sie Ihren Such-Client und überprüfen Sie das JSON-Suchergebnis, das auf der Standardausgabe ausgegeben wird.

Alle anderen Anfragen können auf ähnliche Weise erstellt werden. Codebeispiele dafür finden Sie in den Markdown-Dateien in der generierten Dokumente Ordner.