SuperAPI AI 工具集

701-technologies-openapi

编程与开发

查看项目

更新于 10-15 22:39

技能介绍

用途:该技能提供框架无关的 OpenAPI 3.x 最佳实践,帮助团队产出可维护、与 HTTP 语义和消费方需求保持一致的 API 契约,聚焦契约优先的设计、质量与治理。

主要能力:覆盖文档结构(openapi、info、servers、tags 及一致的资源分组);路径与操作设计(参数、请求体、响应矩阵、operationId、状态码);可复用组件(schemas、parameters、responses、security schemes)与示例;校验与 CI(规范 lint、破坏性变更检查、代码生成前的门禁);契约中的安全建模(schemes、scopes、全局与操作级安全);并明确契约优先设计与运行时实现关注点之间的边界。

使用方式:适用于评审 OpenAPI、改进 OpenAPI、改进 API 契约、改进 API schema 设计、校验 OpenAPI 规范等场景。工作流为:先阅读 references/701-technologies-openapi.md 并检查当前 API 与上下文产物;再明确目标、约束与最小安全变更集;随后按参考模式与项目约定实施或重构;最后执行相应检查并汇报变更、验证结果与后续动作。

限制与约束:建议保持在 OpenAPI 层,除非用户明确要求 Java 框架集成;指导以契约为核心,不规定框架特定的控制器接线或运行时暴露细节;模糊目标需先澄清再改动;缺少上下文、文件、凭据或工具时应明确报告阻塞。若在同一变更集中提出 Java 或 Maven 改动,须先运行 ./mvnw compile 或 mvn compile;推广变更前运行 ./mvnw clean verify 或 mvn clean verify。编辑本仓库 XML 源后需重新生成技能并验证构建。