Api Conventions logo

Api Conventions

CommunityPopular
huangjia2019
api-conventions

API design patterns and conventions for this project. Covers RESTful URL naming, response format standards, error handling, and authentication requirements. Use when writing or reviewing API endpoints, designing new APIs, or making decisions about request/response formats.

Overview

Publisherhuangjia2019
Repositoryclaude-code-engineering
Skill nameapi-conventions
Stars
1.1K
Forks
398
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 huangjia2019 on GitHub. Read the source before you install it.

Installation

Install the Api Conventions 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.
    https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions
  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/huangjia2019/claude-code-engineering.git /tmp/claude-code-engineering
mkdir -p .claude/skills
cp -r /tmp/claude-code-engineering/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions .claude/skills/api-conventions
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Api Conventions 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 Conventions 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 Conventions 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 Design Conventions

These are the API design standards for our project. Apply these conventions whenever working with API endpoints.

URL Naming

  • Use plural nouns for resources: /users, /orders, /products
  • Use kebab-case for multi-word resources: /order-items, /user-profiles
  • Nested resources for belongsTo relationships: /users/{id}/orders
  • Maximum two levels of nesting; beyond that, use query parameters
  • Use query parameters for filtering: /orders?status=active&limit=20

Response Format

All API responses must follow this structure:

json
{
  "data": {},
  "error": null,
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 100
  }
}
  • data: 成功时返回的业务数据
  • error: 错误时返回错误对象 { code, message, details },成功时为 null
  • meta: 分页和元信息,列表接口必须返回

HTTP Status Codes

  • 200: 成功返回数据
  • 201: 成功创建资源
  • 400: 请求参数错误
  • 401: 未认证
  • 403: 无权限
  • 404: 资源不存在
  • 422: 业务逻辑错误
  • 500: 服务器内部错误

Authentication

  • All endpoints require Bearer token unless explicitly marked as public
  • Public endpoints must be documented with @public annotation
  • Token format: Authorization: Bearer <jwt-token>

Versioning

  • API version in URL path: /api/v1/users
  • Breaking changes require new version

Frequently asked questions

What does the Api Conventions AI skill do?

API design patterns and conventions for this project. Covers RESTful URL naming, response format standards, error handling, and authentication requirements. Use when writing or reviewing API endpoints, designing new APIs, or making decisions about request/response formats.

Why use Api Conventions on TypingMind?

Because you install it once and use it with any model. Api Conventions 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 Conventions in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Api Conventions?

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 Conventions?

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

Is the Api Conventions AI skill free?

It is published on GitHub by huangjia2019. 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 👇