技能 api-documentation

📦

api-documentation

Name: api-documentation
Author: CuriousLearner

內容修訂 r1 安全 ⚙️ 外部命令🌐 網路存取🔑 環境變數

產生 API 文件

API 團隊需要能夠準確匹配不斷變更的端點與範例的文件。此技能可協助 Claude、Codex 與 Claude Code 建立參考資料、指南與互動式文件。

支援: Claude Codex Code(CC)

🥉 77 銅級

Maintain this Skill? Claim it 🥉 77 銅級

使用我的智慧代理安裝

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

智能體請求

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

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

Agent 可讀資源

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

Markdown 詳情 GET /skills/curiouslearner-api-documentation.md 已簽名 manifest GET /api/skills/curiouslearner-api-documentation/manifest 已簽名 lockfile GET /api/skills/curiouslearner-api-documentation/lockfile

測試它

正在使用「api-documentation」。用於使用者、組織、驗證與帳單端點的 OpenAPI 規格。

預期結果:

依資源分組的端點參考資料。
驗證與 token 處理指南。
錯誤、分頁與速率限制章節。
常見請求的語言範例。

正在使用「api-documentation」。 TypeScript 或 Python 服務的現有程式碼註解。

預期結果:

包含端點摘要、參數描述、回應註解與缺漏文件問題的結構化草稿。

正在使用「api-documentation」。為開發者入口網站發布互動式文件的請求。

預期結果:

一份設定計畫，用於比較文件工具、必要資產、託管步驟，以及發布前的審查檢查。

安全審計

安全

v8 • 2026/7/5 開啟版本化報告

Static findings were caused by Markdown code fences, example commands, placeholder API keys, and sample HTTP requests in SKILL.md. No evidence of prompt injection, credential exfiltration, obfuscated code, or automatic command execution was found.

已掃描檔案

888

分析行數

複核項目

已忽略的誤報

風險因素

⚙️ 外部命令 (87)

SKILL.md:44-50 SKILL.md:50-57 SKILL.md:57-82 SKILL.md:82-85 SKILL.md:85-97 SKILL.md:100-106 SKILL.md:106-111 SKILL.md:111-124 SKILL.md:141-145 SKILL.md:145-148 SKILL.md:148-163 SKILL.md:163-167 SKILL.md:167-185 SKILL.md:185-191 SKILL.md:191-264 SKILL.md:264-268 SKILL.md:268-315 SKILL.md:315-319 SKILL.md:319-385 SKILL.md:385-391 SKILL.md:391-394 SKILL.md:394-400 SKILL.md:400-402 SKILL.md:402-404 SKILL.md:404-412 SKILL.md:412-414 SKILL.md:414-427 SKILL.md:427-444 SKILL.md:444-448 SKILL.md:448-449 SKILL.md:449-450 SKILL.md:450-454 SKILL.md:454-457 SKILL.md:457-459 SKILL.md:459-466 SKILL.md:466-468 SKILL.md:468-477 SKILL.md:477-481 SKILL.md:481-483 SKILL.md:483-489 SKILL.md:489-496 SKILL.md:496-500 SKILL.md:500-508 SKILL.md:508-512 SKILL.md:512-513 SKILL.md:513-514 SKILL.md:514-515 SKILL.md:515-521 SKILL.md:521-529 SKILL.md:529-549 SKILL.md:549-553 SKILL.md:553-559 SKILL.md:559-560 SKILL.md:560-564 SKILL.md:564-574 SKILL.md:574-580 SKILL.md:580-581 SKILL.md:581-584 SKILL.md:584-588 SKILL.md:588-601 SKILL.md:601-604 SKILL.md:604-608 SKILL.md:608-617 SKILL.md:617-621 SKILL.md:621-631 SKILL.md:631-635 SKILL.md:635-643 SKILL.md:643-649 SKILL.md:649-666 SKILL.md:666-674 SKILL.md:674-680 SKILL.md:680-715 SKILL.md:715-719 SKILL.md:719-733 SKILL.md:733-737 SKILL.md:737-746 SKILL.md:746-750 SKILL.md:750-778 SKILL.md:778-784 SKILL.md:784-798 SKILL.md:798-802 SKILL.md:802-805 SKILL.md:806-808 SKILL.md:813-815 SKILL.md:822-824 SKILL.md:827-829 SKILL.md:834-836

🌐 網路存取 (35)

🔑 環境變數 (7)

SKILL.md:603 SKILL.md:611 SKILL.md:626 SKILL.md:637 SKILL.md:652 SKILL.md:742 SKILL.md:745

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

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

分享與引用此報告

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

開啟版本化報告

複製報告連結

https://skillstore.io/skills/curiouslearner-api-documentation/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown 徽章

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

HTML 徽章

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

嵌入卡片

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

CuriousLearner. (2026). api-documentation security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/curiouslearner-api-documentation/audits/8

BibTeX 引用

@techreport{curiouslearner-curiouslearner-api-documentation-2026,
  author = {CuriousLearner},
  title = {api-documentation security audit report (audit version 8)},
  institution = {Skillstore},
  year = {2026},
  number = {8},
  url = {https://skillstore.io/skills/curiouslearner-api-documentation/audits/8},
  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-documentation security audit report (audit version 8)"
version: "unspecified"
type: report
authors:
  - name: "CuriousLearner"
date-released: "2026-07-05"
url: "https://skillstore.io/skills/curiouslearner-api-documentation/audits/8"
identifiers:
  - type: other
    value: "skillstore:curiouslearner-api-documentation:audit:8"
    description: "Skillstore immutable audit report identifier"

比較變體

3 個可安裝變體

每位作者的技能都保留為獨立的可安裝項目。推薦變體依 Skillstore 證據排序。

為何此變體排名第一

Skillstore 使用量較高

作者 / 來源 Skillstore 評分證據置信度 Skillstore 使用量已更新

supercent-io 推薦

supercent-io-api-documentation

Skillstore 評分 78

證據置信度高

Skillstore 使用量 21

已更新

2026-09-09

sickn33

sickn33-api-documentation

Skillstore 評分 78

證據置信度高

Skillstore 使用量 15

已更新

2026-09-09

CuriousLearner 目前

curiouslearner-api-documentation

Skillstore 評分 77

證據置信度高

Skillstore 使用量 23

已更新

2026-09-09

Skillstore 評分

評分依據證據置信度: 高

架構

可維護性

內容

社群

規範符合度

你可以打造什麼

記錄新 API

從 OpenAPI 規格建立參考頁面、請求範例、結構描述與狀態碼註解。

準備開發者指南

將端點詳細資訊轉換為入門、驗證、錯誤處理、分頁與速率限制指南。

推出互動式文件

規劃包含範例請求與發布步驟的 Swagger UI、Redoc 或 Stoplight Elements 文件。

試試這些提示

建立基本參考資料

為此 OpenAPI 規格產生 API 參考資料。包含端點、參數、結構描述、回應與清楚的請求範例。

新增入門指南

為此 API 參考資料建立入門、驗證、錯誤處理、分頁與速率限制文件。

建置互動式文件

為此 API 設計互動式文件設定。針對此專案比較 Swagger UI、Redoc 與 Stoplight Elements。

規劃多格式發布

為 Markdown、HTML、Postman collection 與 SDK 文件輸出建立發布計畫。包含驗證與審查步驟。

最佳實務

將 OpenAPI 規格作為唯一真實來源，並在 API 變更後重新產生文件。
發布前替換 placeholder tokens、domains 與範例。
發布前在 staging environment 中測試每個範例請求。

避免

未檢查驗證、錯誤與速率限制詳細資訊就發布產生的文件。
將真實 secrets 混入範例或螢幕截圖。
未設限制就對 production endpoints 使用互動式 try-it-out 功能。

常見問題

此技能最適合搭配哪些輸入？

OpenAPI 或 Swagger 檔案效果最佳。程式碼註解、路由清單與現有文件也能提供有用的結構。

它可以建立互動式文件嗎？

可以。它可以規劃 Swagger UI、Redoc 與 Stoplight Elements 設定，並附上專案特定的設定註解。

它會驗證即時 API 行為嗎？

不會。發布前應先針對 staging service 測試產生的範例。

它能協助 SDK 文件嗎？

可以。它可以概述 SDK 產生步驟，並為產生的 clients 撰寫使用文件。

它會安全地處理 API keys 嗎？

它會在範例中使用 placeholders。請勿將真實憑證貼到 prompts、範例或已發布的文件中。

它會自動執行設定命令嗎？

不會。它提供設定指引。使用者只有在自行選擇時，才應核准並執行專案命令。

開發者詳細資訊

作者

CuriousLearner

授權

MIT

Skillstore 修訂

版本提示

作者未聲明版本。

儲存庫

https://github.com/CuriousLearner/devkit/tree/main/skills/api-documentation

引用

02f077c174c5335e2f5d02ca15e77b70d9543e58

維護新鮮度

2026/7/22

使用量

11 次下載 · 337 次瀏覽

檔案結構

📄 SKILL.md

CuriousLearner 的更多技能

查看全部

📦

dead-code-detector

清理前找出死碼

未使用的程式碼會拖慢審查並增加維護風險。此技能可協助 Claude、Codex 和 Claude Code 識別移除候選項，並提供審查指引。

程式開發查看

📦

code-reviewer

審查程式碼品質與安全性

當審查者時間不足時，程式碼審查可能會遺漏安全性、測試與可維護性問題。此技能會引導 Claude、Codex 和 Claude Code 進行結構化審查，並產出按優先順序排列的發現項目。

程式開發查看

📦

dependency-updater

安全地稽核相依套件更新

相依套件更新可能隱藏重大變更與緊急安全需求。此技能會檢閱專案 manifest、摘要更新風險，並建議安全升級的順序。

DevOps 與基礎設施查看

📦

refactor-assistant

透過結構化指引安全地重構程式碼

當變更範圍很廣或說明不清時，重構可能會引入錯誤。此技能可協助 Claude、Codex 和 Claude Code 規劃並套用更安全的漸進式改善。

程式開發查看

📦

performance-profiler

分析應用程式效能瓶頸

緩慢的程式碼可能隱藏在演算法、渲染、資料庫查詢和 bundles 之中。此技能會檢視原始碼模式，並產出依優先順序排列的最佳化建議。

程式開發查看

📦

log-analyzer

更快速地分析應用程式日誌

日誌檔案中隱藏著服務故障、錯誤激增和緩慢請求。此技能會將原始日誌轉換為結構化發現、時間軸和實用的修復建議。

DevOps 與基礎設施查看

查看全部

📦

api-documenter

建立準確的 API 文件

由 sickn33

當規格、範例和入口網站與實際行為脫節時，API 團隊會浪費時間。這項技能會引導 Claude、Codex 和 Claude Code 建立準確且易於維護的 API 文件。

文件查看

📦