mcpField
O
openapi-spec-generation

openapi-spec-generation

github.com/sickn33開発49.2k219 回インストール1 日前に更新
リポジトリ

openapi-spec-generation について

REST API の OpenAPI 3.1 仕様を作成、保守、検証するスキルです。API 設計から実装の検証、ドキュメント作成まで取り組む開発者向けです。

主な機能

  1. 01OpenAPI 仕様の作成
  2. 02既存コードから仕様を生成
  3. 03API コントラクトの設計
  4. 04仕様に基づく実装の検証
  5. 05クライアント SDK の生成

活用シーン

  1. 01REST API ドキュメントの新規作成
  2. 02既存コードから仕様を作成
  3. 03API 実装とコントラクトの照合
  4. 04仕様からクライアント SDK を生成

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill openapi-spec-generation

インストール後、Claude Code で/openapi-spec-generationを入力して読み込まれたか確認します。

同梱ファイルresources/implementation-playbook.md

詳細

OpenAPI 仕様の生成

RESTful API 向けの OpenAPI 3.1 仕様を作成、維持、検証するための包括的なパターンです。

このスキルを使用する場合

  • API ドキュメントをゼロから作成する場合
  • 既存のコードから OpenAPI 仕様を生成する場合
  • API コントラクトを設計する場合（設計ファーストのアプローチ）
  • API の実装を仕様に照らして検証する場合
  • 仕様からクライアント SDK を生成する場合
  • API ドキュメントポータルをセットアップする場合

このスキルを使用しない場合

  • タスクが OpenAPI 仕様の生成と無関係である場合
  • この範囲外の別のドメインやツールが必要である場合

手順

  • 目標、制約、必要な入力を明確にします。
  • 関連するベストプラクティスを適用し、結果を検証します。
  • 実行可能なステップと検証方法を提供します。
  • 詳細な例が必要な場合は、resources/implementation-playbook.md を開いてください。

リソース

  • 詳細なパターンと例については、resources/implementation-playbook.md を参照してください。

制限事項

  • このスキルは、タスクが上記の範囲に明確に一致する場合にのみ使用してください。
  • 出力を、環境固有の検証、テスト、または専門家によるレビューの代替物として扱わないでください。
  • 必要な入力、権限、安全上の境界、または成功基準が欠けている場合は、作業を停止して確認を求めてください。

コメント

Markdown 対応