·api-interface-design
</>

api-interface-design

tencentblueking/bk-ci

API 接口设计规范,涵盖 RESTful 设计原则、URL 命名、HTTP 方法选择、请求响应格式、错误码定义、版本控制。当用户设计 API 接口、定义 Resource 类、编写接口文档或进行接口评审时使用。

28Installs·0Trend·@tencentblueking

Installation

$npx skills add https://github.com/tencentblueking/bk-ci --skill api-interface-design

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 类、编写接口文档或进行接口评审时使用。 Source: tencentblueking/bk-ci.

View raw

Facts (cite-ready)

Stable fields and commands for AI/search citations.

Install command
npx skills add https://github.com/tencentblueking/bk-ci --skill api-interface-design
Category
</>Dev Tools
Verified
First Seen
2026-02-08
Updated
2026-02-18

Quick answers

What is api-interface-design?

API 接口设计规范,涵盖 RESTful 设计原则、URL 命名、HTTP 方法选择、请求响应格式、错误码定义、版本控制。当用户设计 API 接口、定义 Resource 类、编写接口文档或进行接口评审时使用。 Source: tencentblueking/bk-ci.

How do I install api-interface-design?

Open your terminal or command line tool (Terminal, iTerm, Windows Terminal, etc.) Copy and run this command: npx skills add https://github.com/tencentblueking/bk-ci --skill api-interface-design Once installed, the skill will be automatically configured in your AI coding environment and ready to use in Claude Code or Cursor

Where is the source repository?

https://github.com/tencentblueking/bk-ci