本文へ移動
cccskills
無料GitHub で公開

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.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md1.7 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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:

{
  "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

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

Generate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

Generate API endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

Review code for quality, security, and best practices. Use when the user asks for code review, wants feedback on their code, mentions reviewing changes, or asks about code quality.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

Generate an interactive tree visualization of your codebase. Use when exploring a new repo or understanding project structure.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

huangjia2019 のスキルをすべて見る

このスキルの問題を報告する