--- title: "Verwaltung von API-Referenzen" slug: "how-to-generate-api-documentation-1" updated: 2026-09-28T09:20:58Z published: 2026-09-28T09:20:58Z canonical: "docs.document360.com/how-to-generate-api-documentation-1" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.document360.com/llms.txt > Use this file to discover all available pages before exploring further. # Verwaltung von API-Referenzen Dieser Artikel behandelt alles, was Sie benötigen, um Ihre API in Document360 zu verwalten. Neue Referenzen erstellen, sie mit Ihrer Spezifikation synchronisieren und die verfügbaren Aktionen nutzen, um Ihre API-Dokumentation anzusehen, zu bearbeiten, zu veröffentlichen und zu organisieren. --- ## API-Referenzliste Die API-Referenzliste bietet Ihnen eine zentrale Ansicht aller konfigurierten API-Referenzen in Ihrem Arbeitsbereich. Um darauf zuzugreifen, gehen Sie in der linken Navigationsleiste zur **API-Dokumentation ({ })** und klicken Sie im linken Navigationsbereich auf **API-Referenzen** . Von hier aus können Sie den Namen, den Typ und das zuletzt aktualisierte Datum jeder Referenz sehen. Sie können auch eine neue API-Referenz erstellen, indem Sie oben rechts auf **Neue API** klicken. ![API references list in Document360 showing configured references with options.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/api-references-page.png) --- ## Erstelle eine neue API-Referenz Um eine neue API-Referenz zu erstellen, klicken **Sie auf das** Dropdown-Menü Erstellen in der oberen Navigationsleiste und wählen **Sie Neue API.** Dies öffnet das Referenzfenster Neue API, in dem Sie vier Optionen haben: - **API-Definition hochladen** – Laden Sie eine JSON-, YAML- oder YML-Spezifikationsdatei direkt von Ihrem Gerät oder vom Document360-Laufwerk hoch. - Erstellen **Sie von einer URL** – Rufen Sie Ihre Spezifikation automatisch von einer gehosteten URL ab. - **CI/CD-Fluss** – Integrieren Sie sich in Ihre Pipeline, um die Dokumentation bei jeder Spezifikationsänderung automatisch zu aktualisieren. Erfordert Node.js. - **Probiere die Beispiel-Pet Store API-Datei** aus – Nutze die Beispiel-Spezifikationsdatei von Document360, um den Arbeitsbereich zu erkunden, bevor du deine eigene hochlädst. HINWEIS Document360 unterstützt OpenAPI 2.0, OpenAPI 3.0, OpenAPI 3.1 und Postman API-Spezifikationen. Innerhalb jedes API-Arbeitsbereichs können Sie maximal 3 API-Referenzen erstellen. ### Definition der Upload-API 1. Wählen Sie den **Funkknopf "API-Definition hochladen** ". 2. Klicken Sie **auf 'Von meinem Gerät hochladen** ', um von Ihrem lokalen Speicher hochzuladen, oder **auf 'Vom Laufwerk auswählen** ', um eine Datei von Document360 Drive auszuwählen. Sie können Ihre Datei auch direkt in das Fenster ziehen und absetzen. 3. Document360 analysiert die Datei und generiert die API-Referenz. Wenn Warnungen erkannt werden, erweitern Sie den **Abschnitt Warnungen und Warnungen** , um sie zu überprüfen. 4. Klicken Sie auf **Neue API-Referenz,** um zum Veröffentlichungsbestätigungsfenster zu gelangen. ### Erstellen aus URL 1. Wählen Sie die **Schaltfläche "Aus URL erstellen** " und klicken Sie **auf Weiter**. 2. Gib die URL ein, die auf deine OpenAPI-Spezifikationsdatei zeigt. 3. Klicken Sie auf **Neue API-Referenz**. Document360 holt und verarbeitet die Spezifikation. ### CI/CD-Fluss Der CI/CD-Fluss ermöglicht es Ihnen, Ihre API-Dokumentation automatisch mit Ihrer Spezifikation synchron zu halten. Anstatt bei jeder API-Änderung manuell eine neue Spezifikation hochzuladen, integrieren Sie die Document360-CLI in Ihre Pipeline, sodass die Dokumentation bei jeder Änderung automatisch aktualisiert wird. Für vollständige Einrichtungsanweisungen siehe den Artikel zur [CI/CD-Integration](https://docs.document360.com/docs/de/ci-cd-integration) . --- ## API-Referenzaktionen Sobald eine API-Referenz erstellt wurde, klicken Sie auf das **Mehr-(⋯)-** Symbol daneben in der API-Referenzliste, um auf die folgenden Aktionen zuzugreifen: | Aktion | Was es bewirkt | | --- | --- | | Bearbeitung | Aktualisieren Sie die Spezifikationsdatei oder URL, von der die Referenz erstellt wurde. | | Resync | Regeneriere die Dokumentation von der neuesten Version der Spezifikation auf der bestehenden URL. | | API-Definition anzeigen | Schauen Sie die rohe API-Spezifikationsdatei vor. | | Originale API-Quellcode herunterladen | Lade die aktuelle Version der Spezifikationsdatei auf deinen lokalen Speicher herunter. | | Veröffentlichen | Veröffentlichen Sie alle Entwurfsartikel in der API, die auf die Knowledge Base-Seite verweisen. | | Löschen | Löschen Sie die API-Referenz und alle generierten Inhalte dauerhaft. | | Logbücher ansehen | Überprüfen Sie Warnungen, Warnungen und Fehler vom letzten Import oder Neusynchronisation. | HINWEIS Damit Leser die API-Quelldatei von der Knowledge Base-Seite herunterladen können, stellen Sie sicher, dass in den Einstellungen des Knowledge Base Portals der Schalter **"API-Download-Quellcode anzeigen** " aktiviert ist. --- ## Deine Dokumentation synchron halten Wenn sich Ihre API ändert – neue Endpunkte hinzugefügt, Parameter aktualisiert, Antworten geändert, aber Sie müssen Ihre Dokumentation nicht manuell aktualisieren. Das Regenerieren Ihrer API-Referenz zieht automatisch alle Änderungen aus Ihrer Spezifikation ab. HINWEIS Alle benutzerdefinierten Inhalte, die du zu einzelnen Endpunkt-Artikeln hinzugefügt hast, bleibt erhalten, wenn du deine Dokumentation neu generierst. Nur die von den Spezifikationen generierten Inhalte werden aktualisiert. ### Resync von einer bestehenden URL 1. In der API-Referenzliste klicken Sie auf das **Mehr-(⋯)-** Symbol neben der Referenz, die Sie aktualisieren möchten. 2. Klicken Sie **auf Resync.** Die Dokumentation regeneriert sich von der neuesten Version der Spezifikation unter der bestehenden URL. ### Aktualisieren auf eine neue URL 1. Klicken Sie auf das **Mehr- (⋯)-** Symbol neben der Referenz. 2. Klicken Sie **auf Bearbeiten**. 3. Geben Sie die neue URL im **URL-Feld** ein. 4. Klicken Sie **auf Aktualisieren**. ### Regenerieren aus einer Spezifikationsdatei 1. Klicken Sie auf das **Mehr- (⋯)-** Symbol neben der Referenz. 2. Klicken Sie **auf Bearbeiten**. 3. Laden Sie die neueste Spezifikationsdatei im JSON-, YAML- oder YML-Format hoch. 4. Klicken Sie **auf Aktualisieren**. ### Resync über CI/CD Wenn deine API-Referenz mit dem CI/CD-Flow eingerichtet wurde, erfolgt die Neusynchronisierung automatisch als Teil deiner Pipeline, sobald sich deine Spezifikation ändert. Du kannst auch eine manuelle Neusynchronisation mit dem `apidocs:resync` Befehl auslösen: ``` d360 apidocs:resync \  --apiKey=YOUR_API_KEY \  --userId=YOUR_USER_ID \  --apiReferenceId=YOUR_API_REFERENCE_ID \  --path=PATH_TO_SPEC_FILE ``` Für vollständige Details zur Einrichtung und Verwaltung des CI/CD-Flusses siehe den Artikel zur [CI/CD-Integration](https://docs.document360.com/docs/de/ci-cd-integration) . --- ## Automatische vs. manuelle Neusynchronisation | Erstellungsmethode | Automatische Neusynchronisation | Manuelles Resynchronisieren | | --- | --- | --- | | Dateihochladen | Nicht verfügbar | Ja, über Bearbeiten im Portal | | URL-Import | Nicht verfügbar | Ja, über Resync oder Edit im Portal | | CI/CD-Fluss | Ja – läuft als Teil deiner Pipeline | Ja, führe den CLI-Befehl manuell aus | Wenn du deine API-Dokumentation aus einer URL oder Datei generiert hast, wird sie nicht automatisch aktualisiert. Damit die Dokumentation automatisch aktualisiert wird, integriere dich mit dem CI/CD-Flow. --- ## Verständnis der Endpunkt-Löschung während der Resynchronisierung Wenn Sie Ihre API-Spezifikationsdatei aktualisieren, werden alle Endpunkte, die in der neuen Spezifikation nicht mehr vorhanden sind, dauerhaft gelöscht, zusammen mit allen benutzerdefinierten Inhalten, die diesen Endpunktseiten hinzugefügt werden. Um Ihre Spezifikationsdatei sicher zu aktualisieren: 1. Lade die aktualisierte Spezifikationsdatei im **Referenzfenster "API-Bearbeiten** " hoch. 2. Wenn irgendwelche Endpunkte gelöscht werden, wird eine Warnung angezeigt. Klicken Sie auf **'Gelöschte Endpunkte anzeigen** ', um die Liste der betroffenen Endpunkte einzusehen. 3. Wählen Sie das Kontrollkästchen **"Fortsetzen bestätigen"** aus, um die Löschung zu bestätigen. 4. Klicken Sie **auf Aktualisieren** , um fortzufahren. Gelöschte Endpunkte werden in den **Papierkorb** verschoben, wo sie bis zu 30 Tage vorschauig angezeigt werden können, aber nicht wiederhergestellt werden können. HINWEIS Wenn Sie den Resync-API-Endpunkt programmatisch verwenden, senden `ForceImport = false` Sie die Liste der Endpunkte, die gelöscht werden, ohne weiterzumachen, zur Vorschau. Senden `ForceImport = true` Sie zum Bestätigen und fahren Sie fort. --- ## Dokumente im Entwurf führen Nachdem du eine Spezifikation hochgeladen oder neu synchronisiert hast, kannst du die resultierende Dokumentation im Entwurfsmodus behalten, anstatt sie sofort zu veröffentlichen. - Im Veröffentlichungsbestätigungsfenster klicken Sie **auf Schließen** statt **Veröffentlichen**. Alle generierten Artikel bleiben im Entwurfsmodus. - Entwurfsartikel sind im Bereich Kategorien & Artikel im Portal sichtbar, aber für Leser auf der Knowledge Base-Seite nicht zugänglich. - Sie können vor der Veröffentlichung eigene Inhalte zu Entwürfen überprüfen, bearbeiten und hinzufügen. --- ## Verschachtelte Kategorien Document360 unterstützt bis zu drei Ebenen von Unterkategorien im API-Dokumentationsarbeitsbereich. Kategorien werden basierend auf den Tag-Definitionen in Ihrer Spezifikationsdatei erstellt. Um verschachtelte Kategorien zu erstellen, verwenden Sie das `>` Symbol in Ihren OpenAPI-Tags: ``` tags:  - name: "Pets > Details" ``` Dadurch entsteht eine `Pets` Kategorie mit einer Unterkategorie `Details` darin. Diese Struktur bleibt während des Resynchronisations erhalten. HINWEIS Wenn deine Spezialisierung mehr als drei Ebenen des Verschachtelns definiert, werden alle Kategorien über der dritten Ebene hinaus auf die dritte Ebene gesetzt. --- ## Kategorienordnung Die Reihenfolge, in der Kategorien in deiner Dokumentation erscheinen, entspricht der in deiner Spezifikationsdatei definierten Tag-Reihenfolge. Um die Kategorienreihenfolge zu ändern, ordne das `tags` Array in deiner Spezifikation neu und synchronisiere dich neu. --- ## Kategorieoptionen Ein Rechtsklick auf eine Kategorie im Bereich Kategorien & Artikel erhält folgende Optionen: | Option | Was es bewirkt | | --- | --- | | Umbenennung | Benennen Sie die Kategorie um. | | Artikel | Füge einen neuen Artikel oder Unterartikel in die Kategorie ein. | | Unterkategorie | Füge eine Unterkategorie innerhalb der Kategorie hinzu. | | Änderungsart | Ändere den Kategorietyp. | | Set Drive Ordner | Verknüpfe die Kategorie mit einem Document360 Drive-Ordner. | | API-Referenz bearbeiten | Aktualisiere die Spezifikationsdatei oder URL für die API-Referenz. | | Originale API-Quellcode herunterladen | Lade die aktuelle Spezifikationsdatei herunter. | | Veröffentlichen | Veröffentlichen Sie alle Entwurfsartikel in dieser Kategorie. | | Sicherheit | Konfigurieren Sie, wer über das Portal und die Knowledge Base-Seite auf die Kategorie zugreifen kann. | HINWEIS Sie können Endpunkt-Artikel zwischen Unterordnern innerhalb desselben API-Referenzordners verschieben. Es ist nicht möglich, einen Endpunkt-Artikel von einem API-Referenzordner in einen anderen API-Referenzordner zu verschieben. --- ## Aktualisierung von spezifikationsgenerierten Inhalten über die API Endpunktartikel, die aus einer API-Spezifikation (OpenAPI oder Swagger) generiert werden, sind über die Standard-Inhalts-API-Endpunkte schreibgeschützt und können auf diese Weise nicht abgerufen oder aktualisiert werden. Um diesen Inhaltstyp zu ändern: 1. Aktualisieren Sie Ihre API-Definitionsdatei (OpenAPI/Swagger). 2. Synchronisieren Sie die Dokumentation mit dem Portal, der CLI oder dem CI/CD-Fluss erneut, um die Änderungen widerzuspiegeln. Dadurch bleibt der Inhalt deiner Endpunkt-Referenzen mit deiner API-Spezifikation konsistent. Reguläre Knowledge Base-Artikel, wie Konzeptseiten, Authentifizierungsleitfäden oder andere nicht-spezifikationsbezogene Inhalte, sind nicht an die API-Spezifikation gebunden. Diese können wie andere Inhalte der Knowledge Base über die Standard-API-Endpunkte erstellt, aktualisiert und verwaltet werden. Wenn Sie beim Versuch, Inhalte über die API zu aktualisieren, einen 403-Fehler erhalten, bestätigen Sie zuerst, mit welcher Art von Inhalten Sie arbeiten. Handelt es sich um spezifikationsgenerierte Inhalte, verwenden Sie den oben genannten Resync-Prozess, anstatt die Token-Berechtigungen anzupassen. Handelt es sich um einen Artikel ohne Spezifikation, siehe API-Tokens für Hinweise zur Überprüfung und Aktualisierung von Token-Berechtigungen. HINWEIS Mehrere Mitwirkende können diese nicht-spec-Artikel gleichzeitig bearbeiten, genau wie bei regulären Knowledge Base-Artikeln. Dies gilt nicht für spec-generierte Endpunktartikel, die nur innerhalb ihrer eigenen Inhaltsblöcke bearbeitet werden können. ## FAQ **Wie oft wird eine API-Referenz automatisch neu synchronisiert?** API-Referenzen, die aus einer URL oder Datei erstellt werden, werden nicht automatisch neu synchronisiert. Sie müssen manuell über das Portal aktualisiert werden. Um automatische Updates zu ermöglichen, integrieren Sie sich in den CI/CD-Fluss. **Kann ich einen bestimmten API-Endpunkt-Artikel von einem API-Referenzordner in einen anderen verschieben?** Nein. Du kannst Endpunkt-Artikel zwischen Unterordnern innerhalb desselben API-Referenzordner verschieben, aber nicht zwischen verschiedenen API-Referenzordnern. **Kann ein API-Dokumentationsartikel dieselbe URL wie ein Knowledge Base-Artikel haben?** Nein. API-Dokumentationsartikel und Knowledge Base-Artikel können nicht dieselbe URL teilen. Sie können jedoch unter derselben Subdomain existieren. **Kann ich die generierte Dokumentation im Entwurfsmodus behalten?** Ja. Nachdem Sie eine Spezifikation hochgeladen haben, klicken Sie im Bestätigungsfenster **auf Schließen** statt **Veröffentlichen** . Alle generierten Artikel werden im Entwurfsmodus gespeichert. **Wie viele Kategorieebenen werden unterstützt?** Der API-Dokumentationsbereich unterstützt bis zu drei Unterkategorienebenen. Weitere Ebenen werden auf die dritte Ebene zusammengefasst. **Kann ich aus der Spezifikationsdatei automatisch verschachtelte Ordner erstellen?** Ja, mit dem `>` Symbol in OpenAPI-Tags (z. B. `Pets > Details`). Dies schafft eine hierarchische Struktur, die während der Resynchronisierung erhalten bleibt. **Können Leser während der Ausfallzeiten des Document360-Portals auf die Knowledge Base-Seite zugreifen?** Ja. GET-Aufrufe der Customer API laufen unabhängig vom Document360-Portal, sodass Leser während geplanter Wartungsarbeiten oder Portalausfallzeiten weiterhin auf die Seite zugreifen können. --- ## Hilfreiche Links - [d360 npm-Paket](https://www.npmjs.com/package/d360) - [d360-Quellcode](https://github.com/document360/d360) Application Programming Interface - A set of defined rules and protocols that allows one software application to communicate with and request functionality from another. APIs are the backbone of modern integrations. When Document360 connects to Slack, Intercom, or Google Analytics, it does so through their APIs. Document360 also provides its own REST API, enabling teams to programmatically manage articles, categories, and reader accounts from external systems.