Api Interface Design logo

Api Interface Design

OrganizationPopular
TencentBlueKing
api-interface-design

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

Overview

PublisherTencentBlueKing
Repositorybk-ci
Skill nameapi-interface-design
Stars
2.5K
Forks
524
Bundled files
Instructions only
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by TencentBlueKing on GitHub. Read the source before you install it.

Installation

Install the Api Interface Design AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/TencentBlueKing/bk-ci.git /tmp/bk-ci
mkdir -p .claude/skills
cp -r /tmp/bk-ci/ai/skills/api-interface-design .claude/skills/api-interface-design
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Api Interface Design in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Api Interface Design on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Api Interface Design is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

API 接口设计

适用场景

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

不适用场景

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

快速指导

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

高信号规则

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

关键陷阱

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

延伸阅读

  • 如果你在实现后端服务:再看 backend-microservice-development
  • 如果你在做参数校验:再看 common-technical-practices

Frequently asked questions

What does the Api Interface Design AI skill do?

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

Why use Api Interface Design on TypingMind?

Because you install it once and use it with any model. Api Interface Design is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Api Interface Design in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/TencentBlueKing/bk-ci/tree/master/ai/skills/api-interface-design. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Api Interface Design?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Api Interface Design?

As many as you like. As long as a model supports skills, you can use Api Interface Design with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Api Interface Design AI skill free?

It is published on GitHub by TencentBlueKing. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇