OpenApi Spezifikationen sind sehr hilfreich, um Schnittstellen zu dokumentieren. Jedoch ist es nicht wirklich einfach, die YAML oder JSON Datei zu lesen und verstehen. Hier wäre es schon wenn man die Spezifikation als PDF lesen könnte.

Hier gibt es verschiedene Tools, welche die Dokumente anhand der OpenApi-Spezifikation generieren können.

RapiPDF ist ein solches Tool, welches die OpenApi-Spezifikation in ein PDF Dokument umwandelt. Falls die Spezifikation in einem öffentlichen GitHub-Repository liegt, kann das PDF direkt über die RapiPDF Website erstellt werden. Indem der GitHub raw Link zur Spezifikation angegeben wird.
Es ist jedoch auch möglich, RapiPDF lokal zu hosten und so zu benutzen.

OpenAPI Generator ist ein weiteres Tool. Es kann zwar keine PDFs generieren. Dafür bietet es jedoch die Möglichkeit, die Dokumentation in vielen anderen Formaten wie asciidoc, html und markdown zu generieren. Dazu ist es mit dem OpenAPI Generator möglich, Clients und Server in vielen Programmiersprachen und Frameworks zu generieren.

Edit this page

Last updated 03 März 2025, 09:28 +0100 . history