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

api-and-interface-design

Designs or reviews HTTP, REST, GraphQL, RPC, CLI, webhook, event, and service interfaces with explicit inputs, outputs, errors, compatibility, idempotency, pagination, authentication, versioning, and observability. Use when introducing or changing an API or cross-component contract. Not for internal implementation details with no boundary or for debugging one API failure; use root-cause-debugging there.

インストール方法を見る

含まれるファイル(2)

  • SKILL.md2.0 KB
  • references/contract-checklist.md789 B

SKILL.md(原文)

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

API and Interface Design

Design the contract from the caller's failure modes, not only the happy path.

Establish the contract

  1. Identify consumers, trust boundaries, lifecycle, latency expectations, and ownership.
  2. Define request/command shape, response/event shape, status or error model, validation, defaults, and canonical examples.
  3. Decide idempotency, retries, ordering, pagination, concurrency, rate limits, cancellation, and partial failure behavior.
  4. Define authentication, authorization, sensitive fields, and audit needs.
  5. Decide compatibility and versioning: additive change, migration, deprecation, or explicit breaking release.

Read contract-checklist.md for the review matrix. Keep the contract close to the owning schema or source of truth and generate clients/docs only when the repository already supports generation.

Implementation handoff

Write examples that can become contract tests. Include malformed input, missing resource, duplicate request, timeout, dependency failure, permission denial, and oversized input cases. Make error codes stable enough for callers and messages safe enough for logs and users.

Do not expose internal stack traces, persistence identifiers, or implementation details by accident. Do not add versioning machinery before a compatibility need exists.

Completion condition

Consumers can predict valid requests, successful and failed responses, retry behavior, compatibility impact, and the evidence that proves the boundary.

レビュー

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

同じリポジトリのスキル

概要と使いどころ

Designs and runs reproducible evaluations for AI agents, prompts, tools, skills, and model-backed workflows using realistic datasets, isolated baselines, objective assertions, rubric grading, trajectory analysis, cost/latency tracking, and regression comparison. Use when measuring agent quality, optimizing skill triggering, comparing prompts or models, or gating an AI feature release. Not for ordinary deterministic unit tests.

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

thiientv/godmode962026年8月26日 更新

Reviews an existing codebase for structural friction, unclear ownership, leaky or shallow interfaces, excessive coupling, misplaced state, poor testability, and risky dependency direction, then prioritizes evidence-backed improvement candidates. Use for architecture audits, modularization, modernization, or recurring cross-cutting change pain. Not for designing one new interface, simplifying a local function, or fixing a reproduced bug.

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

thiientv/godmode962026年8月26日 更新

Validates a running application, CLI, API, service, or generated artifact as a user or operator against a prewritten observable behavior contract while remaining source-blind. Use for acceptance checks, runtime proof, anti-fake probes, release smoke tests, or an independent companion to code review. Not for source-quality findings, root-cause diagnosis, or visual design judgment outside the contract.

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

thiientv/godmode962026年8月26日 更新

Closes a completed development branch by checking the final diff and proof, presenting merge, pull-request, keep, or discard options, and cleaning up only after the user or repository workflow chooses a path. Use when feature work is complete and the branch must be integrated or retired. Not for claiming a feature is complete before verification.

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

thiientv/godmode962026年8月26日 更新

Tests a real web user flow with a browser by asserting semantic behavior, network and loading states, keyboard access, responsive layouts, and stable visual evidence. Use for browser bugs, end-to-end UI behavior, responsive or accessibility checks, and screenshot baselines. Not for static source review without a browser or for backend-only tests.

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

thiientv/godmode962026年8月26日 更新

Simplifies recently changed or explicitly scoped code while preserving observable behavior, error semantics, side effects, ordering, and public contracts. Use for readability cleanup, dead-code removal, reducing nesting, eliminating redundant wrappers, or making an implementation easier to maintain. Not for architecture redesign, new behavior, speculative cleanup, or a refactor without an adequate safety net.

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

thiientv/godmode962026年8月26日 更新

thiientv のスキルをすべて見る

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