api-design
一貫性のあるREST APIを設計する
一貫性のないAPIは統合を遅らせ、クライアントエラーを引き起こします。このスキルは、リソース、メソッド、レスポンス、エラー、ページネーション、バージョニング、認証、ドキュメントに関する実践的なRESTガイダンスを提供します。
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。
Review the Skillstore skill "api-design" from https://skillstore.io/skills/benny9193-api-design.md and its manifest at https://skillstore.io/api/skills/benny9193-api-design/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「api-design」を使用しています。 コマースサービス向けにユーザーと注文のエンドポイントを設計してください。
期待される結果:
ユーザーと注文を含むリソースマップ、推奨メソッド、ネストされた関係のガイダンス、ステータスコードの選択、ページネーションに関するメモ。
「api-design」を使用しています。 getUserやcreateOrderのようなアクション名を使うルートをレビューしてください。
期待される結果:
アクション動詞を複数形のリソースに置き換え、各アクションをどのHTTPメソッドで表現すべきかを説明するルートレビュー。
「api-design」を使用しています。 create-userエンドポイントのドキュメント要件を準備してください。
期待される結果:
リクエストフィールド、レスポンス形式、バリデーションエラー、認証、レート制限、シナリオ例を網羅したドキュメントチェックリスト。
セキュリティ監査
安全All 48 static findings are false positives caused by Markdown fences, API examples, and ordinary terminology. The skill contains no executable commands, environment access, prompt injection, or malicious intent.
リスク要因
⚙️ 外部コマンド (41)
🔑 環境変数 (1)
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/benny9193-api-design/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](https://skillstore.io/skills/benny9193-api-design?utm_source=security_passport_badge)HTMLバッジ
<a href="https://skillstore.io/skills/benny9193-api-design?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/benny9193-api-design/security.svg" alt="Skillstore security assessment" loading="lazy"></a>埋め込みカード
<iframe src="https://skillstore.io/embed/skills/benny9193-api-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形式の引用
Benny9193. (2026). api-design security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/benny9193-api-design/audits/9BibTeX形式の引用
@techreport{benny9193-benny9193-api-design-2026,
author = {Benny9193},
title = {api-design security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/benny9193-api-design/audits/9},
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-design security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "Benny9193"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/benny9193-api-design/audits/9"
identifiers:
- type: other
value: "skillstore:benny9193-api-design:audit:9"
description: "Skillstore immutable audit report identifier"
バリアントを比較
インストール可能なバリアント 2 件各作者のスキルは個別のインストール項目として維持されます。推奨バリアントは Skillstore の証拠で順位付けされます。
このバリアントが首位の理由
supercent-io-api-design
2026-09-09
Skillstore スコア
このスコアの理由 証拠の信頼度: 高作成できるもの
新しいREST APIを計画する
実装を開始する前に、一貫したエンドポイント構造を作成します。
エンドポイントの一貫性をレビューする
提案されたルート、ステータスコード、レスポンス形式を実践的なREST規約と照らし合わせます。
APIドキュメントを標準化する
リクエストパラメーター、レスポンススキーマ、例、エラーケースを含むエンドポイントドキュメントを準備します。
これらのプロンプトを試す
これらのリソースに対するRESTエンドポイントを設計してください: [resources]。URLパターン、HTTPメソッド、想定される成功時のステータスコードを含めてください。
これらのAPIルートについてRESTの一貫性をレビューしてください: [routes]。リソースベースの代替案を提案し、各変更を簡潔に説明してください。
このエンドポイントのレスポンスとエラーパターンを定義してください: [endpoint]。成功ケース、バリデーションエラー、認可エラー、必要に応じてページネーションを含めてください。
このAPI設計について、一貫性、バージョニング、ページネーション、認証、レート制限、ドキュメントの不足を監査してください: [api summary]。最も影響の大きい修正を優先してください。
ベストプラクティス
- エンドポイント名を選ぶ前に、リソースと関係から始めます。
- API全体で一貫したレスポンス形式とステータスコードを使用します。
- リリース前に、認証、エラー、レート制限、ページネーション、バージョニングを文書化します。
回避
- getやcreateなどのアクション動詞をRESTリソースURLに入れないでください。
- 公開レスポンスで内部データモデルを直接公開しないでください。
- コレクションエンドポイントでページネーションやレート制限を省略しないでください。