api-documentation-best-practices
OpenAPI、Swagger、RESTful APIドキュメンテーションのベストプラクティスを提供する専門スキル。 Anchors: • 『RESTful Web APIs』(Leonard Richardson)/ 適用: REST APIドキュメンテーション / 目的: リソース設計とHTTP操作の標準化 Trigger: OpenAPI/Swagger定義設計時、APIエンドポイント仕様書作成時、REST APIドキュメント整備時、認証仕様文書化時、エラーレスポンス標準化時、ドキュメントレビュー時に使用
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Features and purpose
OpenAPI、Swagger、RESTful APIドキュメンテーションのベストプラクティスを提供する専門スキル。 Anchors: • 『RESTful Web APIs』(Leonard Richardson)/ 適用: REST APIドキュメンテーション / 目的: リソース設計とHTTP操作の標準化 Trigger: OpenAPI/Swagger定義設計時、APIエンドポイント仕様書作成時、REST APIドキュメント整備時、認証仕様文書化時、エラーレスポンス標準化時、ドキュメントレビュー時に使用
Quick start
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
Guides ↗Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-02-10
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!