このワークフローは、OpenAPI仕様の作成、開発者ガイドの作成、コード例の生成、インタラクティブなドキュメントのセットアップを通じて、開発者が包括的なAPIドキュメントを作成できるように支援します。
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "api-documentation". @api-documentationワークフローを使用して、私のユーザー管理APIのドキュメントを作成してください
النتيجة المتوقعة:
7つのフェーズで包括的なAPIドキュメントの作成をガイドします：
**フェーズ1：API発見**
- エンドポイントのインベントリを作成
- リクエスト/レスポンス形式を文書化
- 認証要件を特定
[具体的なアクションで各フェーズをガイド]
استخدام "api-documentation". e コマースAPIのOpenAPI仕様を作成してください
النتيجة المتوقعة:
OpenAPI仕様の構造は以下の通りです：
```yaml
openapi: 3.0.0
info:
title: E-Commerce API
version: 1.0.0
paths:
/products:
get:
summary: List products
responses:
200:
description: Successful response
```
التدقيق الأمني
آمنSecurity analysis confirms this is a safe documentation workflow skill. The static analyzer flagged 28 instances of 'external_commands' (Ruby/shell backtick execution) and 9 instances of 'weak cryptographic algorithms', but both are false positives. The backticks in the file are Markdown code spans (e.g., `api-documenter`) used for skill name references, not shell command execution. No actual security risks were identified.
مشكلات متوسطة المخاطر (2)
درجة الجودة
ماذا يمكنك بناءه
新しいAPIプロジェクトのドキュメント作成
OpenAPI仕様、開発者ガイド、インタラクティブなドキュメントを含む、新しいREST APIの完全なドキュメントを最初から作成します。
既存APIのドキュメント更新
OpenAPI仕様、コード例、インタラクティブな試用機能を含むように、既存のAPIドキュメントを更新して现代化します。
内部APIポータルの作成
包括的なドキュメント、コードサンプル、統合ガイドを含む内部APIポータルを構築し、内部チーム向けに提供します。
جرّب هذه الموجهات
@api-documentationワークフローを使用して、私のREST APIのドキュメントを作成してください。エンドポイントリストがあり、OpenAPI仕様と開発者ガイドの生成を手伝ってくれる必要があります。
@api-documentationを使用して、私のAPIのOpenAPI仕様を作成してください。このAPIはJWTによる認証を使用し、ユーザー、製品、注文のエンドポイントを含みます。
@api-documentationワークフローを使用して、既存のAPIドキュメントにコード例を追加してください。Python、JavaScript、cURLの例が必要です。
@api-documentationを使用して、既存のOpenAPI仕様に対してSwagger UIとRedocでインタラクティブなドキュメントをセットアップしてください。試用機能を設定してください。
أفضل الممارسات
- ドキュメントを生成する前に、すべてのエンドポイントを理解するためにAPI発見から始めてください
- 自動化を使用して、OpenAPI仕様を実際のAPI変更と同期させてください
- 本番環境で動作することを確認するために、すべてのコード例をテストしてください
تجنب
- 発見フェーズをスキップして、ドキュメント生成に直接飛ぶこと
- API仕様の正確性を検証せずにドキュメントを生成すること
- APIが変更されても更新されない静的なドキュメントを作成すること