Elk endpoint-artikel in je API-documentatiewerkruimte bevat een set opties voor het toevoegen van aangepaste content, het configureren van artikelinstellingen, samenwerken met je team en het beheren van de toegang. Dit artikel behandelt alles wat beschikbaar is op een endpoint-artikelpagina.
Aangepaste inhoud toevoegen aan endpoint-artikelen
Je kunt aangepaste content direct toevoegen en opmaken binnen je API-endpointpagina's met behulp van de ingebouwde editor. Dit is handig om gebruiksnotities, codevoorbeelden of context toe te voegen die niet in je OpenAPI-specificatie wordt vastgelegd.
Om inhoud toe te voegen aan een eindpuntpagina:
- Navigeer naar API-documentatie ({ }) in de linker navigatiebalk.
- Open het eindpuntartikel dat je wilt bewerken.
- Klik op het (+)- icoon om een editorblok onder de door specificaties gegenereerde content in te voegen.
- Voer je content in en maak het op met de toolbar-opties.
Je content wordt automatisch opgeslagen. Alle aangepaste content die je toevoegt, blijft behouden wanneer je je API-documentatie opnieuw genereert of synchroniseert.
Editor-toolbar
De endpoint artikeleditor ondersteunt basisopmaakopties - vet, cursief en onderstrepen, samen met de mogelijkheid om een link in te voegen, een bestand toe te voegen of een afbeelding in te sluiten. Deze opties zijn beschikbaar in de werkbalk bovenaan het editorblok.
Aangepaste content die aan endpointpagina's wordt toegevoegd, blijft behouden wanneer je je API-documentatie opnieuw genereert of synchroniseert.
Artikelinstellingen
Elk eindpuntartikel heeft een artikelinstellingenpaneel dat toegankelijk is via het (⋯) -icoon in de bovenste navigatiebalk van de editor. Dit geeft je toegang tot extra configuratieopties voor het artikel.
Aangezien elk van deze instellingen een eigen artikel heeft, biedt deze sectie een kort overzicht en links naar de relevante documentatie.
| Setting | Wat het doet |
|---|---|
| Recensieherinnering | Stel een herinnering in om het artikel op specifieke tijdstippen te beoordelen, hetzij door het te markeren voor beoordeling of door een herinnering in te plannen. |
| Aangepaste velden | Voeg aangepaste metadatavelden toe aan het artikel. |
| GEO/SEO | Configureer SEO-instellingen, waaronder metatitel, beschrijving en geo-targeting. |
| Zoekzichtbaarheid | Bepaal of het artikel in de zoekresultaten verschijnt. |
| Tags | Voeg tags toe aan het artikel voor betere vindbaarheid. |
| Labels | Pas labels toe om artikelen te categoriseren en te filteren. |
| Gerelateerde artikelen | Link naar gerelateerde artikelen die lezers nuttig kunnen vinden. |
| Uitgelichte afbeelding | Stel een uitgelichte afbeelding in voor het artikel. |
| Bijlagen | Voeg bestandsbijlagen toe aan het artikel. |
| Statusindicator | Stel een statusindicator in om de staat van het artikel aan te geven. |
| Voorkeuren | Stel de voorkeuren op artikelniveau in. |
| Editortype | Wissel tussen redacteurstypes voor het artikel. |
| Markeer als verouderd | Markeer het artikel als verouderd om aan te geven dat het niet langer actief wordt onderhouden. |
Voor gedetailleerde instructies over elke setting, zie het artikel over artikelbeheer .
Opties voor eindpuntartikelen
Door met de rechtermuisknop op een endpoint-artikel in het Categorieën & Artikelen-paneel te klikken, krijg je de volgende opties:
| Optie | Wat het doet |
|---|---|
| Publiceren | Publiceer het eindpuntartikel op de Knowledge Base-site. |
| Later publiceren | Plan het artikel in om op een specifieke datum en tijd te verschijnen. |
| Hernoeming | Hernoem het eindpuntartikel. |
| Beveiliging | Configureer wie het artikel zowel via het portaal als de kennisbanksite kan openen. |
Discussies
Het discussiepaneel stelt je in staat direct gesprekken met je team te voeren over een eindartikel. Dit is handig om feedback achter te laten, problemen te markeren of updates te coördineren zonder de documentatie te verlaten.
Om het Discussiepaneel te openen, klik je op het Discussie-icoon in de bovenste navigatiebalk van de editor. Je kunt een nieuw gesprek starten en @ gebruiken om een specifiek teamlid te noemen.
FAQ
Wordt aangepaste content behouden wanneer ik mijn API-documentatie opnieuw synchroniseer?
Ja. Alle aangepaste content die je toevoegt aan endpoint-artikelen blijft behouden wanneer je je API-documentatie opnieuw genereert of synchroniseert. Alleen de door specificaties gegenereerde content wordt bijgewerkt.
Kan ik artikelen als PDF downloaden via de API?
Momenteel is er geen optie om artikelen als PDF's te downloaden via de API-eindpunten.
Wat gebeurt er met aangepaste content wanneer een endpoint wordt verwijderd tijdens het opnieuw synchroniseren?
Wanneer een endpoint uit je specificatie wordt verwijderd en een resync wordt uitgevoerd, worden het endpoint-artikel en alle aangepaste inhoud permanent verwijderd. Verwijderde eindpunten worden naar de prullenbak verplaatst, waar ze tot 30 dagen kunnen worden bekeken, maar niet kunnen worden hersteld.