Skip to content
TrustedSkillsbeta
Back to all skills

Api Interface Design

Checked
tencentblueking·vlatest·backend

Helps with API, design as part of building frontend UIs and user experiences workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add tencentblueking/bk-ci --skill api-interface-design -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

tencentblueking

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned tencentblueking/bk-ci at d5420f2d3d.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
d5420f2d3d
Manifest
ai/skills/api-interface-design/SKILL.md
Scanned
1 file, 45 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill assists with designing API interfaces, specifically within the context of building frontend user interfaces and related workflows. It provides guidance on path formats, return structures (including Result<T> for success/failure and Page<T> for pagination), error code conventions (e.g., 2100013 for invalid parameters), and HTTP status code usage. The skill is intended to help define Resource classes and data structures for API requests and responses.

When to use it

  • Designing RESTful API interfaces.
  • Defining Resource classes within an API structure.
  • Understanding and adhering to the specified error code format (21(Platform)01(Service)001(Business Code)).
  • Designing request/response data structures for APIs.

Key capabilities

  • Provides path formatting guidelines: /scope/{resource}/{resourceId}/{subResource} with prefixes like /user/, /service/, /build/, and /open/.
  • Defines standardized return formats using Result<T> (status, message, data) and Page<T> (count, page, pageSize, totalPages, records).
  • Specifies an error code format: 21(Platform)01(Service)001(Business Code).
  • Outlines HTTP status code usage guidelines.

Example prompts

  • "Show me the recommended path format for a user pipeline resource."
  • "What is the structure of a Result<T> object?"
  • "Explain the error code format and give an example."

Tips & gotchas

  • This skill focuses on API design, not implementation. For backend microservice development, use the 01-backend-microservice-development skill instead.
  • Parameter validation rules should be handled by the common-technical-practices skill.