Implementing API Documentation

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.6.0</version>
</dependency>

springdoc:
  api-docs.path: /v3/api-docs
  swagger-ui.path: /swagger-ui.html
  swagger-ui.operationsSorter: method
  show-actuator: false
  paths-to-match: /api/**

@OpenAPIDefinition(
  info = @Info(title="Orders API", version="2.1",
               description="Order management",
               contact=@Contact(name="API Team", email="api@example.com")),
  servers = { @Server(url="https://api.example.com") })
@SpringBootApplication
public class App {}

@Operation(summary="Create order", description="Places a new order")
@ApiResponses({
  @ApiResponse(responseCode="201", description="Created"),
  @ApiResponse(responseCode="400", description="Invalid input",
               content=@Content(schema=@Schema(implementation=ProblemDetail.class)))
})
@PostMapping
public ResponseEntity<OrderDto> create(@RequestBody NewOrder body) { /* … */ }

@GetMapping("/{id}")
public OrderDto get(
  @Parameter(description="Order ID", required=true, example="42")
  @PathVariable Long id) { /* … */ }

@Schema(description="A customer order")
public record OrderDto(
  @Schema(description="Order ID", example="42") Long id,
  @Schema(description="Customer email", example="a@b.com") String email,
  @Schema(description="Total amount", example="99.99") BigDecimal total
) {}

@Tag(name="Orders", description="Order operations")
@RestController
public class OrderController { /* … */ }

// Multiple groups
@Bean
GroupedOpenApi publicApi() {
  return GroupedOpenApi.builder().group("public").pathsToMatch("/api/public/**").build();
}

@OpenAPIDefinition(
  security = @SecurityRequirement(name = "bearerAuth"))
@SecurityScheme(name="bearerAuth", type=SecuritySchemeType.HTTP,
                scheme="bearer", bearerFormat="JWT")
@Configuration
public class OpenApiConfig {}

@Hidden
@GetMapping("/internal/debug")
public String internalOnly() { return "…"; }

@Operation(hidden = true)
@PostMapping("/legacy")
public void legacy() {}