SuperAPI AI 工具集

spring-rest-api

编程与开发

查看项目

更新于 10-16 03:43

技能介绍

用途:帮助开发者按行业实践构建健壮、文档完善的 Spring MVC REST API,涵盖控制器、参数校验、错误处理与 OpenAPI 文档。

主要能力:核心包括 @RestController、@RequestMapping、路径变量、查询参数与请求体处理,ResponseEntity 与状态码,@Valid、@NotNull 及自定义校验器。进阶包括 @ControllerAdvice 与 RFC 7807 Problem Details 异常处理、JSON/XML 内容协商与自定义转换器、CORS 配置。高级包括 HATEOAS 超媒体 API、URL 与请求头两种 API 版本策略、springdoc-openapi 文档。

参数:api_version(字符串,可选,默认 v1,模式 v[0-9]+)、content_type(枚举,可选,默认 json,可选 json|xml|both)、documentation(枚举,可选,默认 openapi,可选 openapi|none)。

使用方式:以 Skill("spring-rest-api") 调用。示例控制器含分页列表、按 id 查询、创建与删除方法;请求 DTO 用 record 配合 @NotBlank、@Size、@NotNull、@DecimalMin;全局异常处理器返回 ProblemDetail。另有 @WebMvcTest 单元测试模板。

适用场景:需要规范构建 Spring Boot REST 接口、统一校验与错误响应、生成 OpenAPI 文档的项目。

限制:资料未提供安装命令、具体依赖版本、收费与价格信息;示例代码仅为片段,完整配置与运行环境暂未提供。排错表列出 404 缺 @RestController、请求体为 null 缺 @RequestBody、校验失效缺 @Valid 等情况。