APIドキュメントジェネレーター
OpenAPI 3.0 / Swagger YAMLドキュメントをビジュアルに構築。エンドポイント、パラメータ、リクエストボディ、レスポンス、スキーマをフォームで定義します。
このツールについて
APIドキュメントジェネレーターは、YAMLを手書きする代わりにビジュアルフォームを通じて OpenAPI 3.0（旧Swagger）YAMLドキュメントを作成する無料のブラウザベースツールです。 API情報の入力、サーバーの定義、HTTPメソッド（GET、POST、PUT、DELETE、PATCH）による エンドポイントの追加、パラメータ（query、path、header、cookie）の設定、 リクエストボディ、ステータスコード付きレスポンス、再利用可能なコンポーネントスキーマを 入力しながら、リアルタイムで有効なOpenAPI 3.0.3 YAMLを生成します。
ビルダーはOpenAPI仕様の主要セクションをすべてサポートしています： info（タイトル、バージョン、説明、連絡先、ライセンス、利用規約）、 servers（説明付きの複数サーバーURL）、paths（完全な操作詳細を持つ 無制限のエンドポイント）、components/schemas（型付きプロパティと必須フィールド マーカーを持つ再利用可能なデータモデル）。
YAML構文を検証する必要がある場合は、 YAMLフォーマッターでフォーマットとエラー検出を試してください。 JSONとYAML形式の変換には、JSON to YAML変換ツールが 双方向変換に対応しています。 JSONスキーマジェネレーターを使用して サンプルデータからスキーマを作成し、APIドキュメントに貼り付けることもできます。
すべての処理はブラウザ内で完全に実行されます。API定義、エンドポイントの詳細、 スキーマ情報がサーバーに送信されることはありません。社内API仕様や 独自のエンドポイント設計でも安全に使用できます。
使い方
- API Infoセクションに、APIのタイトル、バージョン、説明を入力します。必要に応じて連絡先情報とライセンスの詳細を追加します。
- ServersにベースURLと説明を含む1つ以上のサーバーを追加します（例：本番、ステージング、開発）。
- Add EndpointをクリックしてAPIエンドポイントを作成します。HTTPメソッド（GET、POST、PUT、DELETE、PATCH）を選択し、パス（例：
/users/{id}）を入力します。 - 各エンドポイントにParameters（query、path、header、cookie）を名前、型、必須ステータスとともに追加します。POST/PUT/PATCHメソッドには、コンテンツタイプとスキーマ参照を含むRequest Bodyを追加します。
- 各エンドポイントのResponsesをステータスコード（200、201、400、404など）、説明、オプションのスキーマ参照とともに定義します。
- Schemas / Componentsセクションを展開して、型付きプロパティを持つ再利用可能なデータモデルを定義します。リクエストボディとレスポンスでこれらのスキーマを参照します。
- 右パネルで生成されたOpenAPI YAMLを確認します。CopyをクリックするかCtrl+Shift+Cを押してコピー、またはDownloadをクリックして
openapi.yamlとして保存します。
人気のAPIドキュメント例
よくある質問
どのバージョンのOpenAPIを生成しますか？
このツールはOpenAPI Specification バージョン3.0.3を生成します。これは最も広くサポートされているバージョンで、Swagger UI、Redoc、Postman、およびほとんどのAPIゲートウェイと互換性があります。OpenAPI 3.0はSwagger 2.0の後継で、複数サーバー、ファーストクラスオブジェクトとしてのリクエストボディ、より柔軟なコンポーネントモデルのサポートが追加されています。
スキーマ間で$ref参照を使用できますか？
はい。Componentsセクションでスキーマを定義すると、スキーマ名を入力することでリクエストボディとレスポンスで参照できます。ツールは適切な$refパス（例：#/components/schemas/User）を自動的に作成します。これによりAPIドキュメントがDRYで保守しやすくなります。
/users/{id}のようなパスパラメータはどう文書化しますか？
変数に中括弧を使用してパスを入力し（例：/users/{id}）、同じ名前（id）のパラメータを追加して位置を'path'に設定します。OpenAPIではパスパラメータは常に必須なので、必須としてマークします。ツールは生成されたYAMLにパラメータ定義を含めます。
認証/セキュリティスキームを定義できますか？
現在のバージョンはコアAPIの構造（パス、パラメータ、スキーマ、レスポンス）に焦点を当てています。OAuth2、APIキー、Bearerトークンなどのセキュリティスキームは、生成されたYAMLに手動で追加できます。ツールは追加のOpenAPIセクションで拡張できる有効なベースを生成します。
生成されたYAMLは有効なOpenAPIですか？
はい。ツールはOpenAPI 3.0.3仕様の構造に従った構文的に有効なYAMLを生成します。出力には適切なYAMLフォーマット、スキーマ参照の正しい$refパス、すべての必須フィールドが含まれます。出力はSwagger EditorやSpectralなどのOpenAPIバリデータで検証できます。
データは安全ですか？
はい。すべてのドキュメント生成はJavaScriptを使用してブラウザ内で完全に実行されます。API定義、エンドポイントの詳細、スキーマ構造、その他のデータがサーバーに送信されることはありません。ツール使用中にブラウザの開発者ツールのネットワークタブで確認できます。
既存のOpenAPIファイルをインポートできますか？
現在のバージョンはAPIドキュメントをゼロから構築するために設計されています。既存のOpenAPIファイルを編集するには、生成されたYAMLを出発点として出力を直接修正できます。YAMLフォーマッターツールは既存のYAMLファイルのフォーマットと検証に役立ちます。
関連ツール
JSONフォーマッター
JSONの整形、検証、ツリー表示をシンタックスハイライト付きで行えます。
YAMLフォーマッター
カスタマイズ可能なインデントと構文エラー表示でYAMLの整形、検証、圧縮を行います。
curl → コード変換
curlコマンドをPython、JavaScript fetch、PHP、Goなどのプログラミング言語に変換します。
JSONスキーマ生成
サンプルJSONから型推論、必須フィールド、ネストされたオブジェクト対応でJSONスキーマを生成します。
JSON ↔ YAML変換
JSONとYAML形式をバリデーション付きで即座に変換します。
OpenAPIエディター
OpenAPI/Swagger仕様をYAMLまたはJSONで編集・プレビューします。ライブエンドポイントレンダリングとスキーマビューア付き。