API 探索
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @org-eyw2ohcx/ziniao-open-skills-ziniao-openapi-explorer。
技能介绍
要解决什么问题
接第三方或内部服务时,常见痛点是:文档散落在 Swagger UI、Confluence 或仓库里的 openapi.yaml,想在写代码前先搞清楚路径、入参、鉴权都得反复切换工具。把规范贴进对话里又容易超出上下文,模型也容易把过时示例当真。
技能如何工作
API 探索(@org-eyw2ohcx/ziniao-open-skills-ziniao-openapi-explorer)以技能形态挂在助手侧,让你在自然语言里做接口侧的路由与语义检索,而不是死记硬背整份规范。
典型用法包括:
- 按业务动词提问,例如「创建订单用哪个
POST、必填字段有哪些」 - 对照 OpenAPI 中的
paths、components/schemas,核对字段类型与枚举 - 在对接前梳理鉴权方式(如
Authorization、apiKey)与错误响应结构
技能会把探索过程约束在「查规范 → 归纳可调用形态」上,方便你再把结论落实为客户端代码或联调清单。
适用边界
它面向读规范、拆接口,不替代真实环境的联调与契约测试;若规范与线上一致性未验证,仍需以实际响应为准。紫鸟/OpenAPI 相关命名空间以发布方维护的说明为准,勿假设未在资料中写明的能力。
使用场景
- 新项目接入前,需要根据 OpenAPI 列出鉴权方式与各资源的 CRUD 路径
- 联调卡住时,想快速确认某个 query 参数是否在规范里标记为 required
- 重构客户端前,对照 schema 核对枚举值与嵌套对象字段是否仍与线上一致
- Code Review 中看到新接口调用,需对照规范核对该 HTTP 方法与请求体结构
适合人员
- 负责微服务对接的后端工程师,需要在写 SDK 前把路径与 schema 捋清
- 维护 BFF 或网关转化的全栈开发,要快速回答「这个业务动作对应哪个 REST 端点」
- 编写自动化测试的 QA,希望从规范抽取用例边界而非凭接口文档截图
- 接手遗留集成的外包开发,首次阅读陌生团队的 OpenAPI 时需要结构化导览