SuperAPI AI 工具集

spring-boot-api-design

编程与开发

查看项目

更新于 10-15 22:13

技能介绍

用途:为 Spring Boot API 设计提供规范,覆盖 OpenAPI 文档、版本管理与全局错误处理,优先级标注为 P0(关键)。

主要能力与要求: OpenAPI(Swagger):使用 springdoc-openapi-starter-webmvc-ui;用 @Operation 与 @ApiResponse 注解并保持简洁;在 DTO 的 @Schema 中定义示例。 API 版本管理:优先采用 URI 版本(/api/v1/),便于缓存;弃用接口使用 @Deprecated 加 OpenAPI 标记。 错误处理(RFC 7807):启用 spring.mvc.problem-details.enabled=true;必要时扩展 ProblemDetail 自定义字段;安全要求:绝不在 API 错误中暴露堆栈跟踪。

反模式:不要返回 Map<K,V> 响应,应返回带类型的 DTO record;不要用请求头版本管理,因其难以测试与缓存;不要隐藏 API,所有端点都需用 Swagger/OpenAPI 记录。

使用方式与限制:资料未提供具体安装命令、完整代码示例或适用平台细节,暂未提供。