designing-apis
より優れたAPI契約を設計する
APIチームには、実装前に一貫した契約が必要です。このスキルは、REST、GraphQL、OpenAPI、エラー、バージョニング、セキュリティに関する選択をガイドします。
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。
Review the Skillstore skill "designing-apis" from https://skillstore.io/skills/cloudai-x-designing-apis.md and its manifest at https://skillstore.io/api/skills/cloudai-x-designing-apis/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「designing-apis」を使用しています。 カスタマーサポートのチケットサービス向けエンドポイントを設計してください。
期待される結果:
- チケット、コメント、割り当て、添付ファイルのリソースを定義します。
- 一覧取得、作成、更新、クローズ、再オープンの操作をRESTメソッドに対応付けます。
- ページネーション、認可に関する注記、エラーレスポンスのガイダンスを含めます。
「designing-apis」を使用しています。 請求サービスのAPI契約をレビューしてください。
期待される結果:
- 請求書と支払いの命名に一貫性がない点を指摘します。
- 競合とバリデーションに関するレスポンスをより明確にすることを提案します。
- バージョニングとレート制限のドキュメント要件を追加します。
「designing-apis」を使用しています。 ユーザープロフィール向けのGraphQL APIを計画してください。
期待される結果:
- 主要なクエリとミューテーションの責務を提案します。
- プロフィール、アカウント、設定の型を高いレベルで定義します。
- 関連データに対する認可とページネーションの要件を記載します。
セキュリティ監査
安全This skill is a static Markdown reference guide for designing REST and GraphQL APIs. All 36 static findings are false positives: the flagged patterns are Markdown code fences misread as shell/Ruby backtick execution, an example placeholder URL, and REST/OpenAPI documentation snippets misread as system reconnaissance. There is no executable code, no network activity, no filesystem or environment access, and no prompt-injection content. The skill is safe.
リスク要因
🌐 ネットワークアクセス (1)
⚙️ 外部コマンド (23)
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/cloudai-x-designing-apis/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](https://skillstore.io/skills/cloudai-x-designing-apis?utm_source=security_passport_badge)HTMLバッジ
<a href="https://skillstore.io/skills/cloudai-x-designing-apis?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/cloudai-x-designing-apis/security.svg" alt="Skillstore security assessment" loading="lazy"></a>埋め込みカード
<iframe src="https://skillstore.io/embed/skills/cloudai-x-designing-apis.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形式の引用
CloudAI-X. (2026). designing-apis security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/cloudai-x-designing-apis/audits/9BibTeX形式の引用
@techreport{cloudai-x-cloudai-x-designing-apis-2026,
author = {CloudAI-X},
title = {designing-apis security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/cloudai-x-designing-apis/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: "designing-apis security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "CloudAI-X"
date-released: "2026-07-18"
url: "https://skillstore.io/skills/cloudai-x-designing-apis/audits/9"
identifiers:
- type: other
value: "skillstore:cloudai-x-designing-apis:audit:9"
description: "Skillstore immutable audit report identifier"
Skillstore スコア
このスコアの理由 証拠の信頼度: 高作成できるもの
新しいプロダクトAPIを計画する
エンジニアリング開始前に、リソース、エンドポイント、リクエスト形式、レスポンス、セキュリティルールを定義します。
API契約をレビューする
リリース前に、エンドポイントの命名、ステータスコード、ページネーション、バージョニング、エラーの一貫性を確認します。
既存サービスをドキュメント化する
既知のエンドポイントとスキーマを、クライアントやパートナー向けの明確なOpenAPI構造に変換します。
これらのプロンプトを試す
[product area]向けのREST APIを設計してください。リソース、エンドポイント、メソッド、ステータスコード、簡単なレスポンス説明を含めてください。
このAPI案をレビューしてください: [description]。ページネーション、バリデーションエラー、認証要件、レート制限、一貫したレスポンスルールを追加してください。
[use case]について、RESTとGraphQLの設計を比較してください。1つのアプローチを推奨し、エンドポイントまたはスキーマのトレードオフを説明してください。
このAPI契約を、命名、セキュリティ、バージョニング、エラーハンドリング、ページネーション、ドキュメントの不足点について監査してください。優先順位付きの変更点を返してください。
ベストプラクティス
- エンドポイントパスを選ぶ前に、リソースと関係性から始めます。
- 一貫したレスポンスエンベロープ、ステータスコード、エラー詳細を使用します。
- 認証、認可、ページネーション、バージョニングを早期にドキュメント化します。
回避
- リソースで明確に表せる場合は、動詞を中心にエンドポイントを設計しないでください。
- URLやエラーメッセージで機密データを公開しないでください。
- 検証とレビューなしにAPI契約を公開しないでください。
よくある質問
このスキルは実装コードを生成しますか？
RESTとGraphQLの両方に対応できますか？
OpenAPIのガイダンスは含まれていますか？
既存のAPIをレビューできますか？
APIセキュリティも扱いますか？
検証コマンドは自動的に実行すべきですか？
開発者情報
作成者
CloudAI-Xライセンス
MIT
Skillstore リビジョン
r2
バージョンに関する注意
作者はバージョンを宣言していません。
参照
c68df504887c54bf71d2d467a1fbebde49467868
メンテナンスの新しさ
2026/7/24
利用状況
6 ダウンロード · 212 閲覧
ファイル構成