Auto-Dokumentation
Automatisch generierte API-Spezifikationen, Domain-Modelle und Architecture Decision Records.
Airbuild generiert Dokumentation parallel zu deinem Code — nicht als Nachgedanke, sondern als integraler Teil des Entwicklungsprozesses. Jedes Projekt mit Backend bringt eine aus dem Code abgeleitete OpenAPI-Spezifikation samt JSON-Schemata für seine Datenmodelle mit. Projekte aus dem Spezifikations-Workflow bekommen zusätzlich Domänenmodell-Dokumentation und Architecture Decision Records (ADRs), die begründen, warum wichtige Entscheidungen so getroffen wurden.
Was Airbuild dokumentiert
OpenAPI-Spezifikationen
Jede generierte API enthält eine vollständige OpenAPI 3.0 Spezifikation mit Request/Response-Schemata, Authentifizierungs-Anforderungen, Fehlercodes und Beispiel-Payloads.
Domain-Modell-Dokumentation
Datenbank-Schemata, Entity-Beziehungen und Geschäftslogik-Regeln werden mit klaren Beschreibungen dokumentiert. Generierte ERD-Dokumentation zeigt Datenflüsse in deinem System.
Architecture Decision Records
Wichtige architektonische Entscheidungen werden als ADRs erfasst - warum eine bestimmte Datenbank gewählt wurde, welche Trade-offs berücksichtigt wurden. Unschätzbar für Onboarding und Wartung.
Dokumentation, die nicht veraltet
API-Dokumentation wird aus dem Code selbst abgeleitet und beim Veröffentlichen neu erzeugt — sie bildet ab, was tatsächlich ausgeliefert wird. Domänenmodelle und ADRs werden mit dem Projekt versioniert.
Automatisch aktuell
Die API-Dokumentation wird aus dem Code selbst abgeleitet: Jedes generierte Backend bringt seine OpenAPI-Spezifikation mit, und die Spec wird beim Veröffentlichen aus dem Code neu erzeugt — sie bildet also ab, was tatsächlich ausgeliefert wird. Die generierte Spec speist auch die API-Prüfungen im Code-Review-Gate vor der Veröffentlichung. Domänenmodelle und Architecture Decision Records entstehen im Spezifikations-Workflow des Suite Builder und werden mit deinem Projekt versioniert.
Häufige Fragen
Was dokumentiert Airbuild automatisch?
Airbuild dokumentiert automatisch die API-Spezifikation im OpenAPI-Format, für jedes Projekt mit Backend. Im Spezifikations-Workflow kommen Domänenmodelle und Architecture Decision Records dazu. Alles entsteht parallel zum Build statt nachträglich geschrieben zu werden, und landet im Projekt, nicht in einem separaten Wiki, das niemand pflegt.
Bleiben die Docs aktuell?
Die Dokumentation bleibt aktuell, weil sie nicht von Hand gepflegt wird: Die API-Spezifikationen werden aus dem Code abgeleitet und bei jeder Veröffentlichung neu erzeugt, bilden also ab, was tatsächlich ausgeliefert wurde. Domänenmodelle und Architecture Decision Records werden mit dem Projekt versioniert und wandern so mit jedem Stand mit.