Verwendung von Swagger Codegen für die Integration über API

Swagger Codegen kann Code für viele verschiedene Programmiersprachen erzeugen. Einige Beispiele sind Java, Python, JavaScript, Lua und PHP. Weitere Informationen finden Sie hier: https://swagger.io/tools/swagger-codegen/

Wie man Java-Code mit Swagger Codegen 2 erzeugt

1) git clonehttps://github.com/swagger-api/swagger-codegen (falls nötig, installieren Sie git bevor Sie diesen Befehl ausführen)

2) cd swagger-codegen

3) mvn clean package (falls nötig, installieren Sie die neueste Version von Java und Apache Maven bevor Sie diesen Befehl ausführen)

4) mkdir ffng-java-client (Sie können diesen Namen oder einen anderen Namen für dieses Verzeichnis wählen. Der Einfachheit halber werden wir dieses Verzeichnis als ffng-java-client)

5) öffnen Sie https://[your FactFinder setup here]/Fact-Finder/swagger-ui.html (Ihre FactFinder-URL mit angehängtem /swagger-ui.html) in Ihrem bevorzugten Browser und kopieren Sie den Swagger-Link, der im Kopf der Seite erscheint. Im Beispielscreenshot unten ist der verlinkte Text ./rest/v5/swagger (verwenden Sie nicht die ungültige URL, die im Screenshot zu sehen ist)

und führen Sie aus:

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

Sie haben soeben Beispielcode für Clients erzeugt, die alle Arten von Anfragen senden können, die FactFinder akzeptiert.

6) cd ffng-java-client

7) kopieren Sie das Search with POST Code-Beispiel aus ffng-java-client/docs/SearchApi.md in eine Java-Quelldatei, zum Beispiel src/main/java/examplecompany/ExampleSearchClient.java und fügen Sie notwendige Teile ein, wie package examplecompany; und public class ExampleSearchClient{.

Machen Sie die erzeugten Klassen, siehe (5), im Klassenpfad Ihres Projekts verfügbar.

8a) tragen Sie die korrekten Zugangsdaten in den basicAuth Teil ein und löschen Sie den OAuth2-part

8b) setzen Sie den korrekten Namen des FactFinder-Kanals.

8c) fügen Sie diesen oder einen ähnlichen Code-Schnipsel ein, um die Suchanfrage zu setzen:

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

9) mvn clean install

10) Führen Sie Ihren ersten Beispiel-Search-Client aus. Da Maven zum Bauen des Projekts verwendet wurde, ist eine einfache Möglichkeit, Ihr Beispiel ebenfalls mit Maven zu starten: mvn exec:java -Dexec.mainClass=examplecompany.ExampleSearchClient

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

Alle anderen Anfragen können auf ähnliche Weise erstellt werden. Sie finden Code-Beispiele dafür in den md-Dateien im erzeugten docs-Ordner.

Wie man Python-Code mit Swagger CodeGen 2 erzeugt

1) git clonehttps://github.com/swagger-api/swagger-codegen (falls nötig, installieren Sie git bevor Sie diesen Befehl ausführen)

2) cd swagger-codegen

3) mvn clean package (falls nötig, installieren Sie die neueste Version von Java und Apache Maven bevor Sie diesen Befehl ausführen)

4) mkdir ffng-python-client

5) öffnen Sie https:FactFinder setup here]/Fact-Finder/swagger-ui.html (Ihre FactFinder-URL mit angehängtem /swagger-ui.html) in Ihrem bevorzugten Browser und kopieren Sie den Swagger-Link, der im Kopf der Seite erscheint. Im Beispielscreenshot unten ist der verlinkte Text ./rest/v5/swagger (verwenden Sie nicht die ungültige URL, die im Screenshot zu sehen ist)

und führen Sie aus:

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

Sie haben soeben Beispielcode für Clients erzeugt, die alle Arten von Anfragen senden können, die FactFinder akzeptiert.

6) cd ffng-python-client

7) kopieren Sie das Search with POST Code-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 Python-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) tragen Sie die korrekten Zugangsdaten in den basicAuth part ein und löschen Sie den OAuth2-part

9b) setzen Sie den korrekten Namen des FactFinder-Kanals.

9c) fügen Sie diesen oder einen ähnlichen Code-Schnipsel ein, um die Suchanfrage zu setzen, indem Sie diese Zeile ersetzen:

search_request = swagger_client.SearchRequest()

durch diese 3 Zeilen::

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

1. Starten Sie Ihren Search-Client und sehen Sie das JSON-Suchergebnis auf der Standardausgabe gedruckt.

Alle anderen Anfragen können auf ähnliche Weise erstellt werden. Sie finden Code-Beispiele dafür in den md-Dateien im erzeugten docs-Ordner.