SpringDoc OpenAPI 3 常用注解使用方法

@RestController
@RequestMapping("/user")
@Tag(name = "用户管理模块", description = "用户的增删改查接口")
public class UserController {
}

@Operation(
    summary = "根据ID查询用户",
    description = "传入用户ID，返回用户详细信息",
    tags = {"用户管理模块"}
)
@GetMapping("/{id}")
public User getUser(@PathVariable Long id) {
}

@GetMapping("/{id}")
public User getUser(
    @Parameter(description = "用户ID", required = true, example = "1001")
    @PathVariable Long id
) {
}

@Operation(...)
@ApiResponses({
    @ApiResponse(responseCode = "200", description = "查询成功"),
    @ApiResponse(responseCode = "404", description = "用户不存在"),
    @ApiResponse(responseCode = "500", description = "服务器异常")
})
@GetMapping("/{id}")
public User getUser(@PathVariable Long id) {
}

@Schema(description = "用户信息实体")
public class User {
}

@Schema(description = "用户ID", example = "1001")
private Long id;
@Schema(description = "用户名", requiredMode = Schema.RequiredMode.REQUIRED)
private String username;

@Hidden
@GetMapping("/internal")
public void internalApi() {
}

@RestController
@RequestMapping("/user")
@Tag(name = "用户管理模块", description = "用户相关接口")
public class UserController {
    @Operation(
        summary = "根据ID查询用户",
        description = "根据用户唯一ID查询用户详情"
    )
    @ApiResponses({
        @ApiResponse(responseCode = "200", description = "成功"),
        @ApiResponse(responseCode = "404", description = "用户不存在")
    })
    @GetMapping("/{id}")
    public User getUser(
        @Parameter(description = "用户ID", required = true, example = "1001")
        @PathVariable Long id
    ) {
        return new User();
    }
}

@Schema(description = "用户信息")
public class User {
    @Schema(description = "用户ID", example = "1001")
    private Long id;
    @Schema(description = "用户名", requiredMode = Schema.RequiredMode.REQUIRED)
    private String username;
}

http://localhost:端口/swagger-ui.html