api-contract-doc-sync

To prevent OpenAPI documentation drift, run a contract-doc-sync workflow that detects impacted endpoints and verifies code contracts align with Swagger descriptions. It ensures DTOs, validations, and examples match client-facing docs.

The best way to sync API contracts with Swagger documentation is enforcing a standard workflow with automated checks. This verifies consistency between implemented payloads, responses, HTTP statuses, and OpenAPI textual descriptions.

You need rg and find tools installed to check API contract consistency across endpoints. These dependencies allow the workflow scripts to locate and validate updated DTOs, commands, queries, and endpoint descriptions.

Yes, you can detect which endpoints are impacted by API payload and validation changes. The workflow identifies affected endpoints and ensures code contracts, tests, and OpenAPI documentation reflect the exact same changes.

You should run an API contract documentation sync workflow whenever DTOs, commands, queries, validations, examples, or endpoint descriptions change. This prevents drift between code and client-facing Swagger surfaces.