> For the complete documentation index, see [llms.txt](https://docs.fact-finder.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fact-finder.com/integration/de/factfinder-search-integration/integrating-the-search-into-the-shop-system/how-to-use-swagger-codegen-for-the-integration-via-api.md).
# Wie man Swagger Codegen für die Integration über die API verwendet
Erstellen 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. Erfahren Sie hier mehr:
## So generieren Sie Java-Code mit Swagger Codegen 2
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\) Bauen 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 jeden beliebigen Verzeichnisnamen wählen. Der Einfachheit halber verwendet diese Anleitung **ffng-java-client**.
5\) Öffnen Sie **https\://\[your FactFinder setup here]/Fact-Finder/swagger-ui.html** in Ihrem Browser und kopieren Sie den im Seitenkopf angezeigten Swagger-Link. Im folgenden Screenshot lautet der verlinkte Text **./rest/v5/swagger**. Verwenden Sie nicht die im Screenshot angezeigte ungültige URL.
Führen Sie dann Folgendes aus:
`java -jar Module/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i [Ihr Swagger-Link hier] -l java -o ./ffng-java-client`
Dadurch wird Beispiel-Client-Code für alle von FactFinder unterstützten Anfragetypen generiert.
6\) Wechseln Sie in das generierte Client-Verzeichnis:
`cd ffng-java-client`
7\) Kopieren Sie das **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 der Classpath Ihres Projekts verfügbar.
8a) Geben Sie die richtigen Anmeldedaten im **basicAuth** Abschnitt ein und entfernen Sie das **OAuth2** Abschnitt.
8b) Legen Sie den richtigen FactFinder-Kanalnamen fest.
8c) Fügen Sie diesen oder einen ähnlichen Codeausschnitt ein, um die Suchanfrage festzulegen:
```language-plaintext
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 das Projekt mit Maven erstellt 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 im generierten `docs` Ordner.
## So generieren Sie Python-Code mit Swagger Codegen 2
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\) Bauen 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\://\[your FactFinder setup here]/Fact-Finder/swagger-ui.html** in Ihrem Browser und kopieren Sie den im Seitenkopf angezeigten Swagger-Link. Im folgenden Screenshot lautet der verlinkte Text **./rest/v5/swagger**. Verwenden Sie nicht die im Screenshot angezeigte ungültige URL.
Führen Sie dann Folgendes aus:
`java -jar Module/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i [Ihr Swagger-Link hier] -l python -o ./ffng-python-client`
Dadurch wird Beispiel-Client-Code für alle von FactFinder unterstützten Anfragetypen generiert.
6\) Wechseln Sie in das generierte Client-Verzeichnis:
`cd ffng-python-client`
7\) Kopieren Sie das **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:
```language-python
class MyConfiguration(swagger_client.Configuration):
def auth_settings(self):
return {
'basicAuth':
{
'type': 'basic',
'in': 'header',
'Schlüssel': 'Authorization',
'Wert': self.get_basic_auth_token()
}
}
```
8b) Ersetzen Sie die Zeile:
```language-python
configuration = swagger_client.Configuration()
```
mit der Zeile:
```language-python
configuration = MyConfiguration()
```
9a) Geben Sie die richtigen Anmeldedaten in die **basicAuth** Abschnitt ein und entfernen Sie das **OAuth2** Abschnitt.
9b) Legen Sie den korrekten FactFinder-Kanalnamen fest.
9c) Fügen Sie diesen oder einen ähnlichen Codeausschnitt ein, um die Suchanfrage festzulegen, indem Sie diese Zeile ersetzen:
```language-python
search_request = swagger_client.SearchRequest()
```
mit diesen drei Zeilen:
```language-python
query = "*"
search_params = swagger_client.SearchParams(query=query)
search_request = swagger_client.SearchRequest(search_params)
```
10. Starten Sie Ihren Suchclient und überprüfen Sie das auf der Standardausgabe ausgegebene JSON-Suchergebnis.
Alle anderen Anfragen können auf ähnliche Weise erstellt werden. Codebeispiele dafür finden Sie in den Markdown-Dateien im generierten `docs` Ordner.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.fact-finder.com/integration/de/factfinder-search-integration/integrating-the-search-into-the-shop-system/how-to-use-swagger-codegen-for-the-integration-via-api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.