본문으로 건너뛰기
cccskills
무료GitHub에 공개

api-and-interface-design

Design API and module boundaries with clear contracts, error semantics, pagination, and additive compatibility. Use before implementing REST/GraphQL endpoints, SDKs, or public module APIs.

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

설치 방법 보기

포함된 파일(1)

  • SKILL.md2.1 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

API and Interface Design

Contract-first design for HTTP APIs, GraphQL, CLI surfaces, and library module boundaries. Complements secure-api-design (security) and agent-tool-contracts (LLM tools) with general interface ergonomics and evolution rules.

When to use

  • New public or cross-team API
  • Breaking-change review
  • Designing pagination, filtering, idempotency, or error shapes

When not to use

  • Internal refactor with no boundary change
  • Security-only audit (use secure-api-design)
  • Agent tool schema only (use agent-tool-contracts)

Design checklist

Contract

  • Resource naming consistent (nouns, plural collections)
  • Versioning strategy documented (URL prefix, header, or additive-only)
  • Request/response schemas with examples for happy path + common errors
  • Idempotency keys for mutating operations where retries matter

Errors

  • Stable machine-readable codes separate from human messages
  • HTTP/status mapping documented; no stack traces in client responses
  • Validation errors: field-level detail when safe (no PII leakage)

Pagination and lists

  • Cursor-based preferred for large/live datasets; offset only when bounded
  • Default and max page size documented
  • Sort/filter params explicit; reject unknown params predictably

Compatibility

  • Additive changes only in minor versions
  • Deprecation headers or sunset dates for removals
  • Consumer migration notes in changelog

Observability

  • Correlation/request IDs in responses or logs
  • Rate-limit headers where applicable

Workflow

  1. Draft resource model and primary use cases
  2. Write example requests/responses (including errors)
  3. Run doubt-driven-review or secure-api-design for high-risk surfaces
  4. Implement with tests locked to contract examples

Output

  • Short design note or OpenAPI/GraphQL schema sketch
  • Compatibility and deprecation table if evolving an existing API

리뷰

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

댓글

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

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

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

0 / 1,000자

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

같은 저장소의 스킬

"Implement and select ad bidding strategies from manual CPC to automated target-CPA and target-ROAS. Use this skill when the user needs to choose a bidding strategy, set up automated bidding, or optimize bid parameters — even if they say 'what bidding strategy should I use', 'target CPA setup', or 'smart bidding configuration'.".

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

charlieviettq/awesome-agent-skill262026년 7월 20일 업데이트

"Optimize advertising budget allocation across campaigns using marginal returns analysis. Use this skill when the user needs to distribute budget across multiple campaigns, optimize spend pacing, or maximize overall ROAS under budget constraints — even if they say 'how to split my ad budget', 'campaign budget optimization', or 'diminishing returns on ad spend'.".

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

charlieviettq/awesome-agent-skill262026년 7월 20일 업데이트

"Build CTR prediction models for estimating ad click-through rates from features. Use this skill when the user needs to predict click probability, build an ad ranking model, or evaluate ad creative performance — even if they say 'predict click rate', 'ad relevance scoring', or 'which ad will get more clicks'.".

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

charlieviettq/awesome-agent-skill262026년 7월 20일 업데이트

"Implement Generalized Second Price auction for ad slot allocation and pricing. Use this skill when the user needs to understand search ad auctions, compute ad positions and costs-per-click, or analyze bidding dynamics — even if they say 'how does Google Ads auction work', 'ad rank calculation', or 'second price auction for ads'.".

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

charlieviettq/awesome-agent-skill262026년 7월 20일 업데이트

"Implement VCG mechanism for incentive-compatible ad slot allocation with truthful bidding. Use this skill when the user needs to design a truthful auction mechanism, compute externality-based payments, or understand why platforms may prefer GSP over VCG — even if they say 'truthful auction design', 'VCG payments', or 'incentive-compatible mechanism'.".

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

charlieviettq/awesome-agent-skill262026년 7월 20일 업데이트

"Explain blockchain fundamentals including distributed ledger architecture, consensus mechanisms, and block structure. Use this skill when the user needs to understand blockchain concepts, evaluate whether blockchain fits a use case, or design a blockchain-based solution — even if they say 'how does blockchain work', 'do I need blockchain', or 'distributed ledger'.".

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

charlieviettq/awesome-agent-skill262026년 7월 20일 업데이트

charlieviettq의 스킬 모두 보기

이 스킬의 문제 신고