api-interface-design
✓API 接口设计规范,涵盖 RESTful 设计原则、URL 命名、HTTP 方法选择、请求响应格式、错误码定义、版本控制。当用户设计 API 接口、定义 Resource 类、编写接口文档或进行接口评审时使用。
SKILL.md
| /user/ | 用户态接口 | 前端 Web | | /service/ | 服务间调用 | 其他微服务 | | /build/ | 构建相关 | Agent/Worker | | /open/ | 对外开放 | 第三方系统 |
| 200 | 请求成功 | | 201 | 创建成功 | | 400 | 请求参数错误 | | 401 | 未认证 | | 403 | 无权限 | | 404 | 资源不存在 | | 500 | 服务器内部错误 |
| 创建请求 | [Resource]CreateRequest | PipelineCreateRequest | | 更新请求 | [Resource]UpdateRequest | PipelineUpdateRequest | | 详情响应 | [Resource]Info | PipelineInfo | | 列表项 | [Resource]Summary | PipelineSummary |
API 接口设计规范,涵盖 RESTful 设计原则、URL 命名、HTTP 方法选择、请求响应格式、错误码定义、版本控制。当用户设计 API 接口、定义 Resource 类、编写接口文档或进行接口评审时使用。 来源:tencentblueking/bk-ci。
可引用信息
为搜索与 AI 引用准备的稳定字段与命令。
- 安装命令
npx skills add https://github.com/tencentblueking/bk-ci --skill api-interface-design- 分类
- </>开发工具
- 认证
- ✓
- 收录时间
- 2026-02-08
- 更新时间
- 2026-02-18
快速解答
什么是 api-interface-design?
API 接口设计规范,涵盖 RESTful 设计原则、URL 命名、HTTP 方法选择、请求响应格式、错误码定义、版本控制。当用户设计 API 接口、定义 Resource 类、编写接口文档或进行接口评审时使用。 来源:tencentblueking/bk-ci。
如何安装 api-interface-design?
打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/tencentblueking/bk-ci --skill api-interface-design 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code 或 Cursor 中使用
这个 Skill 的源码在哪?
https://github.com/tencentblueking/bk-ci
详情
- 分类
- </>开发工具
- 来源
- skills.sh
- 收录时间
- 2026-02-08