smithery/tencentblueking

api-interface-design

设计 BK-CI API 契约时使用，例如 Resource 路径设计、HTTP 方法选择、请求响应对象、错误码和版本策略。当用户要定义接口而不是实现业务逻辑时优?

Installation

$ npx skills add smithery/tencentblueking --skill api-interface-design

View on skills.sh ↗ Website ↗

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

frontend-design Same topic

anthropics/skills

Guidance for distinctive, intentional visual design when building new UI or reshaping an existi…

866.4K installs

agent-browser Same topic

vercel-labs/agent-browser

Browser automation CLI for AI agents. Use when the user needs to interact with websites, includ…

810.4K installs

vercel-react-best-practices Same topic

vercel-labs/agent-skills 697.8K installs

web-design-guidelines Same topic

vercel-labs/agent-skills

Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "chec…

617.3K installs

microsoft-foundry Same topic

microsoft/azure-skills

Build, deploy, evaluate, optimize, fine-tune, and manage Microsoft Foundry agents, models, and …

576.5K installs

azure-diagnostics Same topic

microsoft/azure-skills

Debug Azure production issues on Azure using AppLens, Azure Monitor, resource health, and safe …

568.9K installs

Also in this package

Other skills from smithery/tencentblueking · top by installs.

npx skills add smithery/tencentblueking

yaml-pipeline-transfer 0 worker-module-architecture 0 utility-components 0 unit-testing 0 supporting-modules-architecture 0 store-module-architecture 0 repository-module-architecture 0 project-module-architecture 0 process-module-architecture 0 pipeline-variable-management 0

Browse all from smithery/tencentblueking

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared

Cursor Not declared

Codex Not declared

GitHub Copilot Not declared

Windsurf Not declared

Gemini CLI Not declared

Cline Not declared

OpenCode Not declared

Package contents

Files included with this skill beyond the listing page.

skill md SKILL.md 1,627 B
docs SUMMARY.md 272 B

History

Sep 10, 2026 First recorded snapshot · 0 installs

SKILL.md

API 接口设计

适用场景

设计新的 RESTful API
定义 Resource 接口、请求体和响应体
设计错误码、分页格式和版本策略
评审接口命名和路径结构

不适用场景

实现业务逻辑或服务分层
处理参数校验落地细节
只改前端页面展示

快速指导

这个 skill 关注的是“接口契约怎么设计”，不是“接口代码怎么实现”。
设计前先判断调用方是谁，再决定 /user/、/service/、/build/、/open/ 等路径前缀。
路径、方法、返回结构、错误码和版本策略要作为一套契约一起设计。
能用资源语义表达的，就不要退化成动作式杂糅接口。
如果问题已经进入服务分层或实现细节，切到 backend-microservice-development。

高信号规则

接口设计的核心是稳定契约，而不是先把功能堆出来
错误码、分页和返回包装会直接影响前后端协作成本
调用方不同，接口前缀和暴露方式也应不同

关键陷阱

路径命名反映不出资源语义
HTTP 方法和真实操作语义不一致
只设计成功响应，不设计错误返回和版本演进