API-Dokumentation

Interessante Möglichkeiten bietet Document360 auch im Bereich API-Dokumentation. Nach dem Hochladen oder Verlinken einer OpenAPI Definition als JSON- oder YAML-File, erzeugt Document360 automatisch Topics für alle API-Endpunkte. Über eine eingebaute „Try it“ Funktion können Nutzer die einzelnen Befehle unmittelbar aus der Dokumentation heraus testen. Automatisch generierte Code-Beispiele in mehreren Programmiersprachen erleichtern Benutzern die Verwendung der API in eigenen Programmen. Das Ergebnis sieht dann z. B. so aus, wie in der Dokumentation zu Document360s eigener API: Kombination mit redaktionell gepflegten Inhalten Bei Bedarf können Sie einem automatisch erzeugten Topic einer API-Dokumentation in Document360 manuell weitere Informationen hinzufügen. Selbstverständlich können Sie manuell auch komplett neue Topics ergänzen. Das Besondere in beiden Fällen: Ändert sich später die Datei mit der OpenAPI Definition, aktualisiert Document360 automatisch alle betroffenen Topics. Ein intelligenter Automatismus sorgt dabei dafür, dass alle zuvor manuell ergänzten Informationen erhalten bleiben und durch das Update nicht überschrieben werden.