Jeder Endpunkt-Artikel in Ihrem API-Dokumentationsbereich enthält eine Reihe von Optionen zum Hinzufügen benutzerdefinierter Inhalte, zur Konfiguration von Artikeleinstellungen, zur Zusammenarbeit mit Ihrem Team und zur Kontrolle des Zugriffs. Dieser Artikel behandelt alles, was auf einer Endpunkt-Artikelseite verfügbar ist.
Hinzufügen von benutzerdefinierten Inhalten zu Endpunktartikeln
Sie können benutzerdefinierte Inhalte direkt innerhalb Ihrer API-Endpunktseiten mit dem integrierten Editor hinzufügen und formatieren. Dies ist nützlich, um Nutzungsnotizen, Codebeispiele oder Kontext hinzuzufügen, der in Ihrer OpenAPI-Spezifikation nicht erfasst wird.
Um Inhalte zu einer Endpunktseite hinzuzufügen:
- Navigiere in der linken Navigationsleiste zur API-Dokumentation ({ }).
- Öffnen Sie den Endpunkt-Artikel, den Sie bearbeiten möchten.
- Klicken Sie auf das (+)- Symbol, um einen Editorblock unter den von den Spezifikationen generierten Inhalten einzufügen.
- Gib deinen Inhalt ein und formatiere ihn über die Toolbar-Optionen.
Deine Inhalte werden automatisch gespeichert. Alle benutzerdefinierten Inhalte, die Sie hinzufügen, werden behalten, wenn Sie Ihre API-Dokumentation neu generieren oder synchronisieren.
Editor-Werkzeugleiste
Der Endpunkt-Artikeleditor unterstützt grundlegende Formatierungsoptionen – Fett, Kursiv und Unterstrichen – sowie die Möglichkeit, einen Link einzufügen, eine Datei anzuhängen oder ein Bild einzubetten. Diese Optionen sind in der Werkzeugleiste oben im Editor-Block verfügbar.
Benutzerdefinierte Inhalte, die auf Endpunktseiten hinzugefügt werden, werden behalten, wenn Sie Ihre API-Dokumentation neu generieren oder synchronisieren.
Artikeleinstellungen
Jeder Endpunkt-Artikel verfügt über ein Artikeleinstellungspanel , das über das (⋯)- Symbol in der oberen Navigationsleiste des Editors zugänglich ist. Das verschafft Ihnen Zugang zu zusätzlichen Konfigurationsoptionen für den Artikel.
Da jede dieser Einstellungen einen eigenen eigenen Artikel hat, bietet dieser Abschnitt einen kurzen Überblick und Links zu der entsprechenden Dokumentation.
| Schauplatz | Was es bewirkt |
|---|---|
| Rezensionserinnerung | Setzen Sie eine Erinnerung ein, den Artikel in bestimmten Abständen zu prüfen, entweder indem Sie ihn zur Überprüfung markieren oder eine Erinnerung planen. |
| Benutzerdefinierte Felder | Füge dem Artikel benutzerdefinierte Metadatenfelder hinzu. |
| GEO/SEO | Konfigurieren Sie SEO-Einstellungen einschließlich Meta-Titel, Beschreibung und Geo-Targeting. |
| Suchsichtbarkeit | Kontrollieren Sie, ob der Artikel in den Suchergebnissen erscheint. |
| Tags | Füge dem Artikel Tags hinzu, um besser auffindbar zu sein. |
| Bezeichnungen | Verwenden Sie Labels, um Artikel zu kategorisieren und zu filtern. |
| Verwandte Artikel | Linke zu verwandten Artikeln, die Leser nützlich finden könnten. |
| Titelbild | Setze ein Feature-Bild für den Artikel. |
| Anhänge | Fügen Sie Dateianhänge zum Artikel hinzu. |
| Statusanzeiger | Stellen Sie einen Statusindikator ein, der den Zustand des Artikels anzeigt. |
| Präferenzen | Konfigurieren Sie Artikel-Niveau-Einstellungen. |
| Editor-Typ | Wechsle zwischen den Editorentypen für den Artikel. |
| Als veraltet markieren | Markiere den Artikel als veraltet, um anzuzeigen, dass er nicht mehr aktiv gepflegt wird. |
Für detaillierte Anweisungen zu jedem Setting siehe den Artikel zur Artikelverwaltung .
Endpunkt-Artikeloptionen
Wenn Sie mit der rechten Maustaste auf einen Endpunkt-Artikel im Bereich Kategorien & Artikel klicken, erhalten Sie folgende Optionen:
| Option | Was es bewirkt |
|---|---|
| Veröffentlichen | Veröffentlichen Sie den Endpunkt-Artikel auf der Knowledge Base-Website. |
| Später veröffentlichen | Planen Sie die Veröffentlichung des Artikels zu einem bestimmten Datum und einer bestimmten Uhrzeit. |
| Umbenennung | Benennen Sie den Endpunkt-Artikel um. |
| Sicherheit | Konfigurieren Sie, wer sowohl vom Portal als auch von der Knowledge Base auf den Artikel zugreifen kann. |
Diskussionen
Das Diskussionspanel ermöglicht es Ihnen, direkt mit Ihrem Team zu einem Endpunkt-Artikel zu sprechen. Das ist nützlich, um Feedback zu hinterlassen, Probleme zu markieren oder Updates zu koordinieren, ohne die Dokumentation zu verlassen.
Um das Diskussionspanel zu öffnen, klicken Sie auf das Diskussionssymbol in der oberen Navigationsleiste des Editors. Du kannst ein neues Gespräch beginnen und @ verwenden, um ein bestimmtes Teammitglied zu erwähnen.
FAQ
Werden benutzerdefinierte Inhalte behalten, wenn ich meine API-Dokumentation neu synchronisiere?
Ja. Jeder benutzerdefinierte Inhalt, den du zu Endpunkt-Artikeln hinzufügst, wird behalten, wenn du deine API-Dokumentation neu generierst oder synchronisierst. Nur der von Specs generierte Inhalt wird aktualisiert.
Kann ich Artikel als PDFs über die API herunterladen?
Derzeit gibt es keine Option, Artikel als PDFs über die API-Endpunkte herunterzuladen.
Was passiert mit benutzerdefinierten Inhalten, wenn ein Endpunkt während der Neusynchronisierung gelöscht wird?
Wenn ein Endpunkt aus deiner Spezifikation entfernt und eine Neusynchronisation ausgeführt wird, werden der Endpunkt-Artikel und alle benutzerdefinierten Inhalte dauerhaft gelöscht. Gelöschte Endpunkte werden in den Papierkorb verschoben, wo sie bis zu 30 Tage vorschauen können, aber nicht wiederhergestellt werden können.