본문으로 건너뛰기
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.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

huangjia2019/claude-code-engineering
설치 방법 보기

포함된 파일(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

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

api-documenting

무료

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.1천2026년 7월 23일 업데이트

api-generating

무료

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.1천2026년 7월 23일 업데이트

api-generating

무료

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.1천2026년 7월 23일 업데이트

code-health-check

무료

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.1천2026년 7월 23일 업데이트

code-reviewing

무료

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.1천2026년 7월 23일 업데이트

codebase-visualizer

무료

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

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

huangjia2019/claude-code-engineering1.1천2026년 7월 23일 업데이트

huangjia2019의 스킬 모두 보기

이 스킬의 문제 신고