OpenAPI DevTools - Chrome-Erweiterung zur automatischen Erstellung von API-Spezifikationen

• Erstellt in Echtzeit OpenAPI-Spezifikationen auf Basis der Netzwerkanfragen einer Webseite
• Fügt den Chrome DevTools einen neuen Tab namens OpenAPI hinzu
  • Erstellt sofort OpenAPI-3.1-Spezifikationen für Websites oder Anwendungen
  • Führt neue Request- und Response-Header, Bodys und Query-Parameter pro Endpunkt automatisch zusammen
  • Beim Klick auf Pfadparameter werden bestehende und zukünftige passende Anfragen zusammengeführt
  • Mit Redocly lassen sich die Spezifikationen im Tool anzeigen und per Klick herunterladen
• Die Erweiterung füllt die Spezifikation automatisch auf Basis der JSON-Anfragen aus, die beim Surfen im Web entstehen
• Im Einstellungsmenü lassen sich Hosts filtern und URL-Pfade parametrisieren
• Auch wenn derselbe Endpunkt mit unterschiedlichen Daten antwortet, nimmt die Erweiterung alle Informationen in die endgültige Spezifikation auf
• Der Zusammenführungsprozess von Anfragen lässt sich nicht rückgängig machen, aber Nutzer können die Spezifikation löschen und jederzeit neu beginnen

[GN⁺]

Hacker-News-Kommentare

• Die Chrome-Erweiterung OpenAPI DevTools wird für ihre Fähigkeit geschätzt, API-Spezifikationen zu erzeugen.
• Nutzer finden sie nützlich, um Code in die JavaScript-Konsole zu schreiben, mit dem sich komplexe Aufgaben schnell ausführen lassen.
• Ein Vorschlag für dieses Tool ist, Authentifizierungs-Header zu dokumentieren und Token-Werte zu speichern, um die Nutzung von APIs zu erleichtern.
• Es wurde der Wunsch nach einer Funktion geäußert, die über einen Button „Als Python-Request kopieren“ Python-Boilerplate-Snippets erzeugt.
• Das Tool wird mit ähnlichen Werkzeugen wie vite-plugin-web-extension und mitmproxy2swagger verglichen, wobei betont wird, dass die Browser-Erweiterungsfunktion sehr praktisch ist.
• Das Tool wurde für seine Fähigkeit gelobt, Website-APIs zu entschlüsseln, was eine knifflige Aufgabe sein kann.
• Es wurden Fragen dazu gestellt, wie gut das Tool mit optionalen Werten umgeht und ob es String-Felder als „Enum“ kennzeichnet.
• Das Tool kann als Schritt in Richtung eines gesamten Webs gesehen werden, das sich trotz Login-/Registrierungsbarrieren in APIs verwandeln lässt.
• Es wurden mehrere Funktionsvorschläge gemacht, darunter das Filtern von Response-Eigenschaften, die Arbeit mit nicht-JSON-Daten, das Gegenprüfen öffentlich dokumentierter APIs mit Hostnamen, das lokale Speichern von Benutzerzugangsdaten und die Generierung von Clients auf Basis von OpenAPI-Spezifikationen.