Spring Boot OpenAPI Contract

Generate the document from the running code, then fix the small set of facts the generator cannot infer. An unreviewed generated document is a defect, not documentation.

When to use

• Adding or changing the springdoc dependency, properties, groups, or UI access rules.
• Reviewing a generated openapi.json for schema defects before publishing it.
• Documenting error responses, security schemes, servers, examples, or deprecation on an operation.
• Producing the spec at build time and gating pull requests on contract drift.
• Diagnosing a spec with missing paths, missing 4xx responses, or object schemas with no properties.

When not to use