Live Documentation beheren
De Live Documentation inschakelen
Om uw API-documentatie te delen met mensen die geen deel uitmaken van uw team, moet u de Live Documentation-functie inschakelen.
Totdat deze is ingeschakeld, is deze alleen zichtbaar als voorbeeld 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 deze in een nieuw tabblad te openen.
De Live Documentation uitschakelen
Schakel uw documentatie uit en selecteer of u het subdomein ervan wilt behouden.
- Als u het documentatiesubdomein wilt vrijgeven, moet u het selectievakje Subdomein van Live API-documentatie behouden
wissen.
Standaard slaat API Designer het subdomein op dat u hebt gedefinieerd toen u de Live Documentation inschakelde. Hierdoor kunt u dezelfde URL behouden als u deze later opnieuw 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 dit
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.