技能 api-design-framework

📦

api-design-framework

Name: api-design-framework
Author: AI Agent Hub

v1.0.0 內容修訂 r2 安全 ⚙️ 外部命令🌐 網路存取

設計正式環境就緒的 API 契約

團隊在設計 API 時，常會出現資源、錯誤與版本控管不一致的情況。此技能為 REST、GraphQL、gRPC、OpenAPI 和 AsyncAPI 工作提供模式、檢查清單與範本。

支援: Claude Codex Code(CC)

🥈 80 銀級

Maintain this Skill? Claim it 🥈 80 銀級

使用我的智慧代理安裝

將此請求複製給你的智慧代理，其中包含權威 Skill 頁面和清單。

智能體請求

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

你的智慧代理仍應顯示其計畫，並依安全政策請求必要確認。

Agent 可讀資源

當 AI Agent、爬蟲或腳本需要乾淨脈絡、而不是讀取完整頁面時，請使用這些連結。

Markdown 詳情 GET /skills/ariegoldkin-api-design-framework.md 已簽名 manifest GET /api/skills/ariegoldkin-api-design-framework/manifest 已簽名 lockfile GET /api/skills/ariegoldkin-api-design-framework/lockfile

測試它

正在使用「api-design-framework」。請求：設計一個用於帳戶管理的 users API。

預期結果:

一個包含使用者端點、HTTP 方法、狀態碼、分頁規則與結構化驗證錯誤指引的資源模型。

正在使用「api-design-framework」。請求：為儀表板決定使用 REST 或 GraphQL。

預期結果:

比較查詢彈性、快取、用戶端複雜度與治理。
根據消費者需求與營運限制提出建議。

正在使用「api-design-framework」。請求：準備訂單處理的事件文件。

預期結果:

以 AsyncAPI 為導向的事件對照圖，包含 channels、訊息名稱、payload 概念、安全性方案與重試預期。

安全審計

安全

v9 • 2026/7/23 開啟版本化報告

All 113 static findings are false positives caused by Markdown backticks, API identifiers, and illustrative URLs in documentation and templates. The files contain no executable commands, runtime network requests, system reconnaissance instructions, or prompt injection text. No semantic security issue was found.

已掃描檔案

2,047

分析行數

複核項目

已忽略的誤報

風險因素

⚙️ 外部命令 (50)

SKILL.md:59-67 SKILL.md:67-70 SKILL.md:70-77 SKILL.md:77-80 SKILL.md:80-88 SKILL.md:88-94 SKILL.md:94-95 SKILL.md:95-96 SKILL.md:96-97 SKILL.md:97-98 SKILL.md:98-99 SKILL.md:99-100 SKILL.md:100-108 SKILL.md:108-131 SKILL.md:131-140 SKILL.md:140-143 SKILL.md:143-156 SKILL.md:156-159 SKILL.md:159-183 SKILL.md:183-188 SKILL.md:188-199 SKILL.md:199-205 SKILL.md:205-218 SKILL.md:218-226 SKILL.md:226-229 SKILL.md:229-232 SKILL.md:232-236 SKILL.md:236-239 SKILL.md:239-242 SKILL.md:242-247 SKILL.md:247-253 SKILL.md:253-256 SKILL.md:256-262 SKILL.md:262-265 SKILL.md:265-270 SKILL.md:270-277 SKILL.md:277-294 SKILL.md:294-299 SKILL.md:299-302 SKILL.md:302-305 SKILL.md:305-308 SKILL.md:308-311 SKILL.md:311-314 SKILL.md:314-323 SKILL.md:323-330 SKILL.md:330-333 SKILL.md:333-355 SKILL.md:355-358 SKILL.md:358-379 SKILL.md:379-384

🌐 網路存取 (14)

SKILL.md:616 templates/asyncapi-template.yaml:80 templates/asyncapi-template.yaml:17 templates/asyncapi-template.yaml:21 templates/asyncapi-template.yaml:542 templates/openapi-template.yaml:22 templates/openapi-template.yaml:26 templates/openapi-template.yaml:28 templates/openapi-template.yaml:31 templates/openapi-template.yaml:33 templates/openapi-template.yaml:35 templates/openapi-template.yaml:308 templates/openapi-template.yaml:344 templates/openapi-template.yaml:370

最近一次完成的靜態與語意稽核未偵測到已確認的安全發現。這並不能證明該 Skill 沒有副作用。

審計單位: codex 檢視審計紀錄 →

分享與引用此報告

分享版本化評估報告、中性徽章、嵌入卡片與引用。Skillstore 只報告證據，不判斷該 Skill 是否安全。

開啟版本化報告

複製報告連結

https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown 徽章

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

HTML 徽章

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

嵌入卡片

<iframe src="https://skillstore.io/embed/skills/ariegoldkin-api-design-framework.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 引用

AI Agent Hub. (2026). api-design-framework security audit report (audit version 9) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9

BibTeX 引用

@techreport{ai-agent-hub-ariegoldkin-api-design-framework-2026,
  author = {AI Agent Hub},
  title = {api-design-framework security audit report (audit version 9)},
  institution = {Skillstore},
  year = {2026},
  number = {9},
  url = {https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9},
  note = {Author version 1.0.0}
}

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-framework security audit report (audit version 9)"
version: "1.0.0"
type: report
authors:
  - name: "AI Agent Hub"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9"
identifiers:
  - type: other
    value: "skillstore:ariegoldkin-api-design-framework:audit:9"
    description: "Skillstore immutable audit report identifier"

Skillstore 評分

評分依據證據置信度: 高

架構

100

可維護性

內容

社群

規範符合度

你可以打造什麼

設計新的服務契約

在實作開始前定義資源、方法、錯誤、分頁與身份驗證。

標準化 API 治理

為各團隊建立 REST、GraphQL、gRPC、OpenAPI 和 AsyncAPI 的共用慣例。

審查 API 發布就緒狀態

在發布前檢查版本控管、文件、錯誤處理、速率限制與棄用計畫。

試試這些提示

審查 REST 基礎

Use the API Design Framework to propose resource names, methods, status codes, and error formats for a simple customer profile API.

草擬 OpenAPI 大綱

Use the API Design Framework to outline an OpenAPI 3.1 contract for a billing API with authentication, pagination, and validation errors.

比較 API 風格

Use the API Design Framework to compare REST, GraphQL, and gRPC for an internal search service. Recommend one approach with tradeoffs.

稽核發布就緒的 API

Use the API Design Framework to review this API proposal for versioning, authorization, idempotency, observability, and breaking-change risk: [paste proposal].