Live documentatie beheren
Laatst bijgewerkt: 09-10-2026De live-documentatie inschakelen
Om uw API-documentatie te delen met mensen die niet in uw team zitten, moet u de Live Documentation-functie inschakelen.
Totdat het is ingeschakeld, is het alleen zichtbaar als preview voor gebruikers die toegang hebben tot de API-definitie.
- Zet de knop Ingeschakeld van Uit
naar Aan en voer een URL in.
Uw Live Documentation is nu beschikbaar. U kunt op Openen klikken om het in een nieuw tabblad te openen.
De live-documentatie uitschakelen
Schakel uw documentatie uit en selecteer of u het subdomein ervan wilt behouden.
- Als u het documentatiesubdomein wilt vrijgeven, moet u het selectievakje Live API-documentatiesubdomein
behouden wissen.
Standaard slaat API Contracts het subdomein op dat u hebt gedefinieerd toen u de Live Documentatie inschakelde. Hiermee kunt u dezelfde URL behouden als u deze later weer inschakelt. Als u dit subdomein voor een andere API wilt gebruiken, moet u het eerst vrijgeven.
Uw Live Documentation is uitgeschakeld. Als u het subdomein hebt behouden, kunt u het
op elk gewenst moment weer inschakelen. Zo niet, dan kan het subdomein door een andere API worden gebruikt en moet u
een subdomein invoeren als u deze documentatie opnieuw wilt inschakelen.