SuperAPI AI 工具集

701-technologies-openapi

编程与开发

查看项目

更新于 10-15 21:49

技能介绍

用途:提供框架无关的 OpenAPI 3.x 契约设计与治理指导,帮助团队产出可维护、与 HTTP 语义和消费方需求保持一致的 API 规范。适用于评审 OpenAPI、改进 API 契约与 schema 设计、校验规范等场景。

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

使用方式:先阅读 references/701-technologies-openapi.md 并检查现有 API 与上下文产物,再确定目标改进与最小安全变更集,按参考模式与项目约定实施或重构,最后执行相应检查并汇报变更与验证结果。

限制:范围仅限契约优先的质量与治理,不规定框架特定的控制器接线或运行时暴露细节,除非用户明确要求 Java 框架集成。编辑本仓库 XML 源后需重新生成技能并验证构建;提出 Java 或 Maven 变更前必须运行 ./mvnw compile 或 mvn compile;编辑技能或系统提示 XML 后须运行 ./mvnw clean install -pl skills-generator 重新生成;提升变更前运行 ./mvnw clean verify 或 mvn clean verify。目标不明确、缺少上下文/文件/凭据/工具,或变更与项目约束冲突时应先停下询问。