Ich hatte die API-Tests mit Swagger oder Postman zwar abgeschlossen, fand es aber repetitiv und ineffizient, die eigentliche Dokumentation separat von Hand in Notion einzutippen. Deshalb habe ich dieses Tool gebaut.
Was ich gebaut habe: Wenn man eine beliebige Datei im Format Swagger/OpenAPI (.json, .yaml), Postman Collection (.json) oder Insomnia Export (.json) hochlädt, wird sie automatisch in ein Markdown-Dokument umgewandelt, in dem Endpoints, Parameter sowie Request-/Response-Beispiele übersichtlich aufbereitet sind. Man kann es direkt kopieren und in Notion einfügen oder als .md-Datei herunterladen und ins Repo legen.
Wie man es ausprobieren kann: Über den obigen Link gelangt man direkt zum Upload-Bildschirm. Selbst wenn man keine passende Datei hat, gibt es dort Beispiel-Datei-Buttons für die einzelnen Formate, sodass man mit einem Klick sofort das Ergebnis ansehen kann.
Was es besonders macht: Ähnliche Tools, die nur Swagger unterstützen, habe ich gesehen. Es war aber schwer, etwas zu finden, das auch Postman-/Insomnia-Exportdateien mitparst und in ein einheitliches Format umwandelt. Genau das habe ich als Differenzierungsmerkmal gewählt. Das Tool erkennt anhand des Dateiinhalts automatisch, um welches Format es sich handelt.
Eine Login-Funktion gibt es noch nicht, und Insomnia kann beispielsweise noch keine Beispiel-Responses übernehmen; es ist also ein frühes MVP. Wenn ihr es ausprobiert und Unbequemlichkeiten bemerkt oder euch Unterstützung für weitere Formate wünscht, hinterlasst gern einen Kommentar.
Einen etwas ausführlicheren Beitrag dazu, warum ich es gebaut habe, habe ich hier hinterlassen:
https://velog.io/@dkslasdud/…
Noch keine Kommentare.