documentation

Generate REST API documentation by reading controller, service, and DTO code to extract endpoints, data models, and parameters. This produces developer-facing docs and frontend integration guides that accurately reflect the current implementation.

Keep frontend integration guides in sync by deriving living docs directly from the codebase rather than outdated contracts. The documentation reads actual REST API surface code to capture real-world usage scenarios and data models.

Codebase-first documentation derives endpoints, data models, and logic directly from controllers, services, and DTOs. You need it when onboarding new developers, validating API behavior, or accelerating frontend integration with accurate references.

Verify existing API documentation by comparing it against current controller, service, and DTO code. All endpoint fields, parameters, and responses are checked, and any deviations from contracts are logged in a deviation log.

Document REST API deviations by comparing existing documentation against actual controller and service code. Deviations from contracts are captured in a deviation log to ensure all fields are accurately reflected in developer-facing docs.

Living documentation derived from code requires accurate controller, service, and DTO code to function properly. It cannot document external integrations or behaviors not explicitly defined within the codebase being analyzed.