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

api-interface-design

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

TencentBlueKing
maintainer
TencentBlueKing
更新於 1/22/2026
星標
2495
分支
520
quick start

Installation and usage

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

安裝
$ install --globalskills.sh
使用

安裝後,您可以透過在終端機執行以下指令來使用此技能:

skills use api-interface-design