home/categories/backend/tencentblueking-bk-ci-ai-skills-02-api-interface-design-skill-md
backenddevelopment

02-api-interface-design

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

TencentBlueKing
maintainer
TencentBlueKing
Updated 1/19/2026
Stars
2487
Forks
514
quick start

Installation and usage

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

Installation
$ install --globalskills.sh
Usage

Once installed, you can use this skill by running the following command in your terminal:

skills use 02-api-interface-design