本文へ移動
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

レビュー

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

同じリポジトリのスキル

概要と使いどころ

"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 のスキルをすべて見る

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