スキル designing-apis
📦

designing-apis

コンテンツリビジョン r2 安全 🌐 ネットワークアクセス⚙️ 外部コマンド

Concevoir de meilleurs contrats d’API

Les équipes API ont besoin de contrats cohérents avant l’implémentation. Cette compétence guide les choix concernant REST, GraphQL, OpenAPI, les erreurs, le versionnement et la sécurité.

対応: Claude Codex Code(CC)
Maintain this Skill? Claim it 🥉 79 ブロンズ

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

このリクエストをエージェントにコピーしてください。正規の 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」を使用しています。 Concevoir des points de terminaison pour un service de tickets de support client.

期待される結果:

  • Définit les ressources ticket, commentaire, assignation et pièce jointe.
  • Associe les opérations de liste, création, mise à jour, fermeture et réouverture aux méthodes REST.
  • Inclut la pagination, des notes d’autorisation et des conseils sur les réponses d’erreur.

「designing-apis」を使用しています。 Examiner un contrat d’API pour un service de facturation.

期待される結果:

  • Signale une dénomination incohérente des factures et des paiements.
  • Suggère des réponses plus claires pour les conflits et la validation.
  • Ajoute des exigences de documentation pour le versionnement et les limites de débit.

「designing-apis」を使用しています。 Planifier une API GraphQL pour des profils utilisateur.

期待される結果:

  • Propose les responsabilités principales des requêtes et mutations.
  • Définit les types profil, compte et préférence à un niveau général.
  • Note les exigences d’autorisation et de pagination pour les données associées.

セキュリティ監査

安全

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.

2
スキャンされたファイル
402
解析済み行数
0
レビュー項目
0
誤検知を無視
最新の完了済み静的・セマンティック監査では、確認済みのセキュリティ検出事項は見つかりませんでした。これは、スキルに副作用がないことを証明するものではありません。
監査者: claude 監査履歴を表示 →
このレポートを共有・引用

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

バージョン別レポートを開く
セキュリティ評価

レポートリンクをコピー

https://skillstore.io/skills/cloudai-x-designing-apis/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdownバッジ

[![Skillstore security assessment](https://skillstore.io/badges/skills/cloudai-x-designing-apis/security.svg)](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/9

BibTeX形式の引用

@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 スコア

このスコアの理由 証拠の信頼度: 高
55
アーキテクチャ
85
保守性
87
コンテンツ
70
コミュニティ
91
仕様準拠

作成できるもの

Planifier une nouvelle API produit

Définir les ressources, les points de terminaison, les formes de requêtes, les réponses et les règles de sécurité avant le début de l’ingénierie.

Examiner un contrat d’API

Vérifier la dénomination des points de terminaison, les codes de statut, la pagination, le versionnement et la cohérence des erreurs avant la publication.

Documenter un service existant

Transformer des points de terminaison et des schémas connus en une structure OpenAPI claire pour les clients et partenaires.

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

Créer une API REST de base
Conçois une API REST pour [product area]. Inclue les ressources, les points de terminaison, les méthodes, les codes de statut et de simples descriptions de réponses.
Ajouter les erreurs et la pagination
Examine cette idée d’API : [description]. Ajoute la pagination, les erreurs de validation, les besoins d’authentification, les limites de débit et des règles de réponse cohérentes.
Comparer REST et GraphQL
Pour [use case], compare les conceptions REST et GraphQL. Recommande une approche et explique les compromis liés aux points de terminaison ou au schéma.
Préparer un examen OpenAPI
Audite ce contrat d’API pour la dénomination, la sécurité, le versionnement, la gestion des erreurs, la pagination et les lacunes de documentation. Retourne les changements priorisés.

ベストプラクティス

  • Commencer par les ressources et leurs relations avant de choisir les chemins des points de terminaison.
  • Utiliser des enveloppes de réponse, des codes de statut et des détails d’erreur cohérents.
  • Documenter tôt l’authentification, l’autorisation, la pagination et le versionnement.

回避

  • Ne pas concevoir les points de terminaison autour de verbes lorsque les ressources sont plus claires.
  • Ne pas exposer de données sensibles dans les URL ou les messages d’erreur.
  • Ne pas publier un contrat d’API sans validation ni examen.

よくある質問

Cette compétence génère-t-elle du code d’implémentation ?
Non. Elle se concentre sur la conception d’API, les contrats, la documentation et les conseils d’examen.
Peut-elle aider à la fois avec REST et GraphQL ?
Oui. Elle inclut des modèles de points de terminaison REST et des modèles de conception de schémas GraphQL.
Inclut-elle des conseils OpenAPI ?
Oui. Elle renvoie vers un modèle OpenAPI 3.0 et recommande des étapes de validation.
Peut-elle examiner une API existante ?
Oui. Fournissez le contrat ou la liste des points de terminaison, puis demandez les lacunes et les améliorations.
Couvre-t-elle la sécurité des API ?
Oui. Elle couvre HTTPS, l’authentification, l’autorisation, la validation, les limites de débit et la gestion des données sensibles.
Les commandes de validation doivent-elles s’exécuter automatiquement ?
Non. Les commandes qui installent ou exécutent des packages ne doivent être lancées qu’après l’approbation explicite de l’utilisateur.

開発者情報

作成者

CloudAI-X

ライセンス

MIT

Skillstore リビジョン

r2

バージョンに関する注意

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

参照

c68df504887c54bf71d2d467a1fbebde49467868

メンテナンスの新しさ

2026/7/22

利用状況

5 ダウンロード · 212 閲覧

ファイル構成

CloudAI-X のその他のスキル

すべて表示
すべて表示