api-design
Concevoir des API REST cohérentes
Des API incohérentes ralentissent l'intégration et provoquent des erreurs côté client. Cette compétence fournit des conseils REST pratiques pour les ressources, les méthodes, les réponses, les erreurs, la pagination, le versionnement, l'authentification et la documentation.
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の 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」を使用しています。 Concevoir des points de terminaison utilisateurs et commandes pour un service de commerce.
期待される結果:
Une carte des ressources avec utilisateurs et commandes, les méthodes recommandées, des conseils sur les relations imbriquées, les choix de codes d'état et des notes sur la pagination.
「api-design」を使用しています。 Examiner des routes qui utilisent des noms d'action comme getUser et createOrder.
期待される結果:
Un examen des routes qui remplace les verbes d'action par des ressources au pluriel et explique quelle méthode HTTP doit exprimer chaque action.
「api-design」を使用しています。 Préparer les exigences de documentation pour un point de terminaison create-user.
期待される結果:
Une checklist de documentation couvrant les champs de requête, la forme de réponse, les erreurs de validation, l'authentification, les limites de débit et des exemples de scénarios.
セキュリティ監査
安全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 スコア
このスコアの理由 証拠の信頼度: 高作成できるもの
Planifier une nouvelle API REST
Créer une structure de points de terminaison cohérente avant le début de l'implémentation.
Examiner la cohérence des points de terminaison
Comparer les routes proposées, les codes d'état et les formes de réponse aux conventions REST pratiques.
Standardiser la documentation API
Préparer la documentation des points de terminaison avec les paramètres de requête, les schémas de réponse, les exemples et les cas d'erreur.
これらのプロンプトを試す
Concevez des points de terminaison REST pour ces ressources : [resources]. Incluez les modèles d'URL, les méthodes HTTP et les codes d'état de réussite attendus.
Examinez ces routes d'API pour vérifier leur cohérence REST : [routes]. Suggérez des alternatives basées sur les ressources et expliquez brièvement chaque changement.
Définissez les modèles de réponse et d'erreur pour ce point de terminaison : [endpoint]. Incluez les cas de réussite, les erreurs de validation, les erreurs d'autorisation et la pagination si nécessaire.
Auditez cette conception d'API pour repérer les lacunes de cohérence, de versionnement, de pagination, d'authentification, de limitation de débit et de documentation : [api summary]. Priorisez les corrections ayant le plus fort impact.
ベストプラクティス
- Commencez par les ressources et les relations avant de choisir les noms des points de terminaison.
- Utilisez des formes de réponse et des codes d'état cohérents dans toute l'API.
- Documentez l'authentification, les erreurs, les limites de débit, la pagination et le versionnement avant la publication.
回避
- N'insérez pas de verbes d'action tels que get ou create dans les URL de ressources REST.
- N'exposez pas directement les modèles de données internes dans les réponses publiques.
- Ne négligez pas la pagination ni la limitation de débit pour les points de terminaison de collection.