スキル api-and-interface-design

📦

api-and-interface-design

Name: api-and-interface-design
Author: addyosmani

コンテンツリビジョン r2 安全 ⚙️ 外部コマンド

Design Stable APIs and Interfaces

Unclear contracts, inconsistent errors, and unsafe retries make APIs difficult to use and evolve. This skill provides practical patterns for typed interfaces, validation boundaries, compatibility, pagination, and idempotency.

対応: Claude Codex Code(CC)

🥉 78 ブロンズ

自分のエージェントでインストール

このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。

エージェントリクエスト

Review the Skillstore skill "api-and-interface-design" from https://skillstore.io/skills/addyosmani-api-and-interface-design.md and its manifest at https://skillstore.io/api/skills/addyosmani-api-and-interface-design/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。

エージェントが読めるリソース

AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。

Markdown詳細 GET /skills/addyosmani-api-and-interface-design.md 署名済み manifest GET /api/skills/addyosmani-api-and-interface-design/manifest 署名済み lockfile GET /api/skills/addyosmani-api-and-interface-design/lockfile

テストする

「api-and-interface-design」を使用しています。 Create a contract for a task service with create, list, update, and delete operations.

期待される結果:

Define typed inputs and outputs for each operation.
Use plural task resources, consistent status codes, structured errors, and paginated list responses.
Make deletion idempotent and specify behavior for missing tasks.

「api-and-interface-design」を使用しています。 Review a charge endpoint that checks for an idempotency key, charges a card, then stores the key.

期待される結果:

The sequence has a race because concurrent requests can both pass the check. Claim the key with a unique constraint before the charge, compare request hashes, and define a deliberate response for in-flight duplicates.

「api-and-interface-design」を使用しています。 Plan a compatible addition of an optional priority field to task creation.

期待される結果:

Add the optional field without changing existing types or removing fields. Document the default, validate it at the API boundary, update shared types, and add contract tests for old clients.

セキュリティ監査

安全

v2 • 2026/9/19 バージョン別レポートを開く

All 52 static findings are false positives from Markdown backticks, TypeScript template literals, REST examples, and ordinary API terminology. The skill is documentation-only and contains no shell execution, system reconnaissance, prompt injection, or malicious intent.

スキャンされたファイル

368

解析済み行数

レビュー項目

誤検知を無視

リスク要因

最新の完了済み静的・セマンティック監査では、確認済みのセキュリティ検出事項は見つかりませんでした。これは、スキルに副作用がないことを証明するものではありません。

監査者: codex 監査履歴を表示 →

このレポートを共有・引用

バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。

バージョン別レポートを開く

レポートリンクをコピー

https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdownバッジ

[![Skillstore security assessment](https://skillstore.io/badges/skills/addyosmani-api-and-interface-design/security.svg)](https://skillstore.io/skills/addyosmani-api-and-interface-design?utm_source=security_passport_badge)

HTMLバッジ

<a href="https://skillstore.io/skills/addyosmani-api-and-interface-design?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/addyosmani-api-and-interface-design/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

埋め込みカード

<iframe src="https://skillstore.io/embed/skills/addyosmani-api-and-interface-design.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

学術引用 (APA · BibTeX · CFF)

APA形式の引用

addyosmani. (2026). api-and-interface-design security audit report (audit version 2) [Author version unspecified]. Skillstore. https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2

BibTeX形式の引用

@techreport{addyosmani-addyosmani-api-and-interface-design-2026,
  author = {addyosmani},
  title = {api-and-interface-design security audit report (audit version 2)},
  institution = {Skillstore},
  year = {2026},
  number = {2},
  url = {https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2},
  note = {Author version unspecified}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-and-interface-design security audit report (audit version 2)"
version: "unspecified"
type: report
authors:
  - name: "addyosmani"
date-released: "2026-09-19"
url: "https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2"
identifiers:
  - type: other
    value: "skillstore:addyosmani-api-and-interface-design:audit:2"
    description: "Skillstore immutable audit report identifier"

Skillstore スコア

このスコアの理由証拠の信頼度: 中

アーキテクチャ

保守性

コンテンツ

コミュニティ

仕様準拠

作成できるもの

Plan a New REST API

Define resource URLs, typed payloads, error responses, pagination, filters, and compatibility rules before implementation.

Review a Public Interface

Inspect an existing API or module boundary for inconsistent contracts, breaking changes, weak validation, and unsafe retry behavior.

Design Reliable Payment Retries

Model idempotency keys, atomic request claims, payload matching, in-flight duplicates, and unknown outcomes for state-changing operations.

これらのプロンプトを試す

Draft an API Contract

Design a REST API for [resource]. Define endpoints, typed inputs and outputs, status codes, error bodies, pagination, and naming conventions.

Improve Interface Consistency

Review this API contract for inconsistent response shapes, validation placement, naming, and backward compatibility. Recommend specific changes: [paste contract].

Plan a Safe Interface Evolution

Design an additive migration from [current interface] to [target interface]. Identify consumer risks, compatibility steps, deprecation timing, and verification checks.

Harden a Retried Operation

Design an idempotent workflow for [operation]. Cover key derivation, unique storage, request hashing, concurrent duplicates, unknown outcomes, retention, and failure recovery.

ベストプラクティス

Define typed contracts before implementation and keep input models separate from output models.
Validate untrusted data at system boundaries, then keep internal functions aligned with shared types.
Design state-changing operations for retries, atomic claims, explicit duplicate handling, and durable evidence.

回避

Returning different error shapes across endpoints or exposing internal server details.
Breaking existing fields, skipping pagination, or adding incompatible changes without a migration path.
Checking an idempotency key and acting later without an atomic uniqueness guarantee.

よくある質問

What kinds of interfaces does this skill cover?

It covers REST APIs, GraphQL schemas, module boundaries, component props, and other public contracts between system parts.

Does this skill generate implementation code?

It provides design guidance and illustrative TypeScript examples. It does not implement, deploy, or test the complete system.

When should validation occur?

Validate external input at API, form, configuration, and third-party response boundaries. Internal code can rely on established contracts.

How does it approach backward compatibility?

Prefer additive optional fields and extensions. Avoid changing existing types or removing observable behavior that consumers may depend on.

Why are idempotency keys important?

Retries can repeat state-changing effects after timeouts. A durable, atomically claimed key lets the system distinguish one intent from repeated attempts.

Can it review an existing API?

Yes. Provide the contract or relevant documentation, and it can identify inconsistent semantics, compatibility risks, validation gaps, and retry hazards.

開発者情報

作成者

addyosmani

ライセンス

MIT

Skillstore リビジョン

バージョンに関する注意

作者はバージョンを宣言していません。

リポジトリ

https://github.com/addyosmani/agent-skills/tree/c004a74784a08295d52749b04cda634125b9a581/skills/api-and-interface-design

参照

5d5054f8a23586f9b500fece1cb613a9dffc787b

メンテナンスの新しさ

2026/9/19

利用状況

0 ダウンロード · 0 閲覧

ファイル構成

Vue 3 のコード品質を向上

作成者 vuejs-ai

Vue プロジェクトでは、時間の経過とともに reactivity、component、performance に関するミスが蓄積しがちです。このスキルは、より安全なパターンと明確なコードのために、Vue 3 に特化したガイダンスを提供します。

コーディング＆開発表示

api-and-interface-design

自分のエージェントでインストール

エージェントが読めるリソース

テストする

セキュリティ監査

リスク要因

レポートリンクをコピー

Markdownバッジ

HTMLバッジ

埋め込みカード

APA形式の引用

BibTeX形式の引用

CITATION.cff

Skillstore スコア

作成できるもの

Plan a New REST API

Review a Public Interface

Design Reliable Payment Retries

これらのプロンプトを試す

ベストプラクティス

回避

よくある質問

開発者情報

addyosmani のその他のスキル

code-review-and-quality

interview-me

planning-and-task-breakdown

documentation-and-adrs

frontend-ui-engineering

debugging-and-error-recovery

関連スキル

api-designer

api-design-framework

playwright-testing

python-fastapi-patterns

starknet-js

vue-best-practices