home/categories/technical-docs/daishiman-aiworkfloworchestrator-docs-99-claude-skills-api-documentation-best-practices-skill-md
technical-docsdocumentation

api-documentation-best-practices

OpenAPI、Swagger、RESTful APIドキュメンテーションのベストプラクティスを提供する専門スキル。 Anchors: • 『RESTful Web APIs』(Leonard Richardson)/ 適用: REST APIドキュメンテーション / 目的: リソース設計とHTTP操作の標準化 Trigger: OpenAPI/Swagger定義設計時、APIエンドポイント仕様書作成時、REST APIドキュメント整備時、認証仕様文書化時、エラーレスポンス標準化時、ドキュメントレビュー時に使用

daishiman
maintainer
daishiman
آخر تحديث 1/18/2026
النجوم
4
التفرعات
0
quick start

Installation and usage

OpenAPI、Swagger、RESTful APIドキュメンテーションのベストプラクティスを提供する専門スキル。 Anchors: • 『RESTful Web APIs』(Leonard Richardson)/ 適用: REST APIドキュメンテーション / 目的: リソース設計とHTTP操作の標準化 Trigger: OpenAPI/Swagger定義設計時、APIエンドポイント仕様書作成時、REST APIドキュメント整備時、認証仕様文書化時、エラーレスポンス標準化時、ドキュメントレビュー時に使用

التثبيت
$ install --globalskills.sh
الاستخدام

بعد التثبيت، يمكنك استخدام هذه المهارة بتشغيل الأمر التالي في الطرفية:

skills use api-documentation-best-practices