Auto-Documentation
Automatically generated API specifications, domain models, and architecture decision records.
Airbuild generates documentation alongside your code — not as an afterthought, but as an integral part of the development process. Every project with a backend ships an OpenAPI specification derived from the code itself, including JSON schemas for its data models. Projects built through the specification workflow additionally get domain model documentation and Architecture Decision Records (ADRs) explaining why key decisions were made.
What Airbuild documents
OpenAPI Specifications
Every generated API includes a complete OpenAPI 3.0 specification with request/response schemas, authentication requirements, error codes, and example payloads. Interactive documentation is available out of the box.
Domain Model Documentation
Database schemas, entity relationships, and business logic rules are documented with clear descriptions. Generated ERD-style documentation shows how data flows through your system.
Architecture Decision Records
Key architectural decisions are captured as ADRs - why a certain database was chosen, why a specific API pattern was used, what trade-offs were considered. Invaluable for onboarding and maintenance.
Documentation That Can't Drift
API documentation is derived from the code itself and regenerated at publish time, so it tracks what actually ships. Domain models and ADRs are versioned with your project as it evolves.
Kept current automatically
The API documentation is derived from the code itself: every generated backend ships with its OpenAPI specification, and the spec is regenerated from the code at publish time, so it tracks what actually ships. The generated spec also powers the API checks in the code-review gate before a publish. Domain models and architecture decision records are generated in Suite Builder's specification workflow and versioned with your project as it evolves.
Frequently asked questions
What does Airbuild auto-document?
Airbuild auto-documents the API specification in OpenAPI format for every project that has a backend. In the specification workflow it adds domain models and architecture decision records. All of it is generated alongside the build rather than written afterwards, and it lives in the project itself rather than in a separate wiki nobody maintains.
Are the docs kept up to date?
The docs stay up to date because they are not maintained by hand: API specs are derived from the code and regenerated at publish time, so they describe what actually shipped rather than what was once planned. Domain models and architecture decision records are versioned with the project and travel with every release.