nirisolutions
← Alle Programme In Arbeit

API-Doku-Automat

Aus dem Programmcode eines Servers wird automatisch eine Schnittstellen-Beschreibung.

Für Programmiererinnen und Programmierer, die ihre Server-Schnittstellen dokumentieren müssen.

Was das Programm kann

Code einlesen

  • Quellcode einfügen oder Dateien und ganze Ordner laden
  • Erkennt Flask, FastAPI, Express und Pythons eingebauten Server
  • Liest Wege, Platzhalter, Felder, Header und Statuscodes, mit Datei und Zeile

Ergebnis

  • OpenAPI-Datei als YAML oder JSON, für Swagger und andere Werkzeuge
  • Lesbare Doku-Seite mit Inhaltsverzeichnis, Feldtabellen und Beispiel-Aufruf
  • Unsichere Erkennungen sind gelb markiert

Stets aktuell

  • Beim erneuten Einlesen zeigt die App neue, geänderte und entfernte Wege
  • Selbst geschriebene Texte bleiben erhalten

Am Computer

  • Code links, Ergebnis rechts, Trennlinie verschiebbar
  • Editor mit Datei-Reitern und Zeilennummern
  • Tastenkürzel und Sprung vom Ergebnis zur Codezeile

Was noch nicht fertig ist

  • Markenprüfung für den Namen fehlt
  • Funktionen mit KI laufen bisher nur in unserer Testfassung

Gut zu wissen

Stand
In Arbeit, private Testfassung
Läuft auf
Im Browser, gebaut für den Computer. Der Code bleibt auf deinem Gerät
Preis
Noch nicht entschieden

Fragen zu API-Doku-Automat? Lust, mitzutesten?

Schreib uns.

contact@niri-solutions.com