スキル api-documentation

📦

api-documentation

Name: api-documentation
Author: supercent-io

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

建立清楚的 API 文件

API 團隊需要準確的文件，用來說明端點、結構描述、身分驗證與錯誤。此技能會將 API 詳細資料轉換為結構化參考資料與指南。

対応: Claude Codex Code(CC)

🥉 78 ブロンズ

Maintain this Skill? Claim it 🥉 78 ブロンズ

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

このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。

エージェントリクエスト

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

エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。

エージェントが読めるリソース

AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。

Markdown詳細 GET /skills/supercent-io-api-documentation.md 署名済み manifest GET /api/skills/supercent-io-api-documentation/manifest 署名済み lockfile GET /api/skills/supercent-io-api-documentation/lockfile

テストする

「api-documentation」を使用しています。團隊提供建立與列出使用者的端點筆記。

期待される結果:

此技能會回傳結構化參考資料，包含端點用途、參數、請求欄位、回應意義與常見錯誤案例。

「api-documentation」を使用しています。產品團隊需要公開 API 發布文件。

期待される結果:

此技能會概述入門指南、身分驗證、速率限制、分頁、變更記錄與特定語言範例章節。

「api-documentation」を使用しています。工程主管想改善現有內部 API 文件。

期待される結果:

此技能會找出缺失的驗證詳細資料、不完整的錯誤回應、薄弱的範例，以及需要更新負責人的章節。

セキュリティ監査

安全

v5 • 2026/7/7 バージョン別レポートを開く

Contextual review found the static findings are false positives from markdown examples, placeholder URLs, and API schema text. No prompt injection, malicious intent, data exfiltration, command execution, or unauthorized network behavior was found in SKILL.md.

スキャンされたファイル

410

解析済み行数

レビュー項目

誤検知を無視

最新の完了済み静的・セマンティック監査では、確認済みのセキュリティ検出事項は見つかりませんでした。これは、スキルに副作用がないことを証明するものではありません。

監査者: codex 監査履歴を表示 →

このレポートを共有・引用

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

バージョン別レポートを開く

レポートリンクをコピー

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

Markdownバッジ

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

HTMLバッジ

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

埋め込みカード

<iframe src="https://skillstore.io/embed/skills/supercent-io-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形式の引用

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

BibTeX形式の引用

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

將端點詳細資料轉換為請求欄位、回應說明、錯誤案例與使用範例。

準備公開 API 發布文件

建立外部參考資料，包含身分驗證、速率限制、範例與入門指引。

協調前端與後端團隊

建立共享 API 合約，釐清結構描述、分頁、錯誤與整合預期。

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

記錄單一端點

為此端點建立 API 文件。包含用途、參數、請求本文、回應、錯誤與一個範例。

建立 OpenAPI 草稿

將這些端點筆記轉換為 OpenAPI 草稿。包含結構描述、安全性、回應模型與驗證限制。

建立互動式文件指引

規劃此服務的互動式 API 文件。包含 Swagger UI 設定、導覽、範例與維護注意事項。

稽核完整 API 文件

審查此 API 文件是否有缺失的結構描述、不清楚的錯誤、薄弱的範例與過時章節。回傳按優先順序排列的改善項目。

ベストプラクティス

提供真實的端點名稱、請求欄位、回應範例與已知錯誤案例。
針對密鑰、權杖、密碼與客戶資料使用預留位置。
在 API 行為變更的同一組變更中更新文件。

回避

不要發布包含真實憑證或正式環境客戶資料的範例。
不要用模糊詞句描述端點，例如 returns data。
不要省略身分驗證、速率限制、分頁或錯誤行為。

よくある質問

此技能可以建立 OpenAPI 文件嗎？

可以。當端點詳細資料與結構描述可用時，它會提供 OpenAPI 與 Swagger 結構。

它支援 GraphQL 文件嗎？

可以。它可以根據提供的 GraphQL 詳細資料，整理結構描述、查詢、突變、型別與範例指引。

它可以自動讀取我的即時 API 嗎？

不可以。請提供原始碼、端點筆記、結構描述或現有文件，以取得最佳結果。

它會建立互動式文件嗎？

它可以指引 Swagger UI 或類似設定，但不會部署託管網站。

我應該如何處理範例中的憑證？

只使用清楚的預留位置。絕不要包含真實金鑰、權杖、密碼或客戶資料。

哪些工具可以使用此技能？

市集 metadata 列出對 Claude、Codex 與 Claude Code 的支援。

開発者情報

作成者

supercent-io

ライセンス

MIT

Skillstore リビジョン

バージョンに関する注意

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

リポジトリ

https://github.com/supercent-io/skills-template/tree/main/.agent-skills/api-documentation/

参照

f93e9bb0daca99badb6a7e574b97737155d57cb3

メンテナンスの新しさ

2026/7/22

利用状況

11 ダウンロード · 127 閲覧

ファイル構成

📄 SKILL.md

📄 SKILL.toon

supercent-io のその他のスキル

すべて表示

📦

prompt-repetition

提升輕量模型準確度

當問題在重要資訊之後才出現時，輕量模型可能會漏掉上下文。此技能會在帶有防護規則的情況下重複適合的提示，以提升所選任務的準確度。

生産性表示

📦

api-design

設計更好的 REST 與 GraphQL API

API 團隊需要在實作開始之前建立一致的合約。本技能會引導資源設計、請求格式、錯誤、版本控管與文件撰寫。

コーディング＆開発表示

📦

code-refactoring

安全地重構程式碼

複雜的程式碼會拖慢變更速度並提高回歸風險。此技能會透過測試、萃取模式和驗證步驟，引導保留行為的重構。

コーディング＆開発表示

📦

user-guide-writing

建立使用者指南與教學

文件團隊需要清楚的產品說明，讓使用者不需支援也能跟著操作。此技能可為終端使用者規劃入門指南、操作文章、教學與 FAQ 的結構。

ドキュメント表示

📦

debugging

系統化地除錯程式碼問題

當症狀掩蓋真正原因時，Bug 會浪費工程時間。此技能會引導結構化重現、隔離、根本原因分析、修復與迴歸預防。

コーディング＆開発表示

📦

task-planning

規劃 Agile 任務與使用者故事

團隊經常收到範圍很廣的功能需求，卻缺少明確任務、優先順序或驗收標準。此技能會將功能想法轉換為使用者故事、Sprint 待辦項目、依賴關係，以及完成定義檢查。

生産性表示

すべて表示

📦