OpenAPI・Swagger 検証ツール
Swagger 2.0 と OpenAPI 3.0・3.1・3.2(YAML/JSON)をブラウザで検証。公式スキーマ、ファイルをまたぐ $ref、パスパラメーター、サンプル値とスキーマの一致を行番号付きで表示。アップロードなし。
- ブラウザ内で処理
- ツールの入力を ZeroTool のサーバーにアップロードしません
- 無料 · 登録不要
WeChat でスキャンしてシェア
例・詳しい説明・よくある質問 実際の出力つきの例、ほかのツールとの違い、よくある質問。
OpenAPI や Swagger の仕様書を貼り付けるか、ファイル・フォルダを開いてください。バージョンに合った公式 JSON Schema で構造を検証し、ファイルをまたいで $ref をたどり、スキーマだけでは表せない規則も確認します。問題には行と列が付き、クリックするとエディターのその行を選択します。
実例:e-Gov 法令API Version 2 の仕様書
デジタル庁の e-Gov 法令API Version 2 は、Swagger UI の画面から仕様書 lawapi-v2.yaml(OpenAPI 3.0.3、info.version 2.1.139、2026-10-02 取得)を読み込んでいます。このファイルを検証するとエラーは 0 件、警告は JSON のサンプル値 5 件でした。そのひとつが、法令番号の年 law_num_year を type: integer と定義しながら、サンプルでは "11" と文字列で書いている箇所です。該当部分を抜き出すと次のとおりです。
openapi: 3.0.3
info:
title: 法令API Version 2(抜粋)
version: 2.1.139
paths:
/law_data/{law_id_or_num_or_revision_id}:
get:
parameters:
- name: law_id_or_num_or_revision_id
in: path
required: true
schema: {type: string}
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/law_info"
examples:
example_law_data_json:
value:
law_id: 411AC0000000127
law_num_year: "11"
law_num_num: "127"
application/xml:
schema:
$ref: "#/components/schemas/law_info"
examples:
example_law_data_xml:
value: <law_info><law_num_year>11</law_num_year></law_info>
components:
schemas:
law_info:
type: object
properties:
law_id: {type: string}
law_num_year:
description: 法令番号の年
type: integer
law_num_num: {type: string}
24:21 警告 サンプル値がスキーマと一致しません(/law_num_year):型は integer である必要があります。
XML のサンプル値は文字列で書かれたシリアライズ済みの本文なので、比較しません(OpenAPI 3.x の Example Object の説明どおり)。元のファイル全体では、Spectral 6.17.0 がサンプル値の不一致を 21 件エラーにし、そのうち 16 件はこの XML 文字列への「type must be object」でした。Redocly CLI 2.57.0 も同じ 16 件を警告にしています。サンプル値の警告は仕様違反ではないため、文書自体は有効と判定されます。
実例:3.0 の書き方のまま 3.1 に上げたスキーマ
OpenAPI 3.1 のスキーマは JSON Schema 2020-12 を土台にした方言です。3.1 の公式スキーマはスキーマの中身をほとんど確かめないので、このツールは各スキーマを 2020-12 のメタスキーマでも検証します。プロパティに required: true を書く、type: int と書く、3.0 の nullable を残す、といった誤りが見つかります。
openapi: 3.1.0
info:
title: 会員 API
version: 1.0.0
paths: {}
components:
schemas:
Member:
type: object
properties:
name:
type: string
required: true
kana:
type: string
nullable: true
age:
type: int
8:5 警告 スキーマ "Member" はどこからも参照されていません。
13:11 エラー "required" の型は array である必要があります。
16:11 警告 "nullable" は OpenAPI 3.0 のキーワードで、3.1 以降では効果がありません。type に "null" を加えてください(例:type: [string, "null"])。
18:11 エラー "type" は次のいずれかにしてください:"array", "boolean", "integer", "null", "number", "object", "string"。
実例:サーバー URL とセキュリティスキーム
ステージごとに URL を切り替える書き方では、variables の書き漏れや、enum にないデフォルト値がよく起きます。3.0 の仕様ではデフォルト値は enum に含まれるべき(SHOULD)なので警告、3.1 以降は MUST なのでエラーです。セキュリティ要件の名前が宣言と違う場合はどのバージョンでもエラーです。
openapi: 3.0.3
info:
title: 予約 API
version: 1.0.0
servers:
- url: https://{stage}.example.jp/{version}
variables:
stage:
default: prod
enum: [dev, stg]
paths:
/reservations:
get:
security:
- api_key: []
responses:
"200": {description: OK}
components:
securitySchemes:
apiKey: {type: apiKey, in: header, name: X-API-Key}
6:5 警告 "https://{stage}.example.jp/{version}" の変数 {version} が variables にないため、URL を展開できません。
9:9 警告 変数 "stage" のデフォルト値 "prod" が enum にありません。
15:11 エラー セキュリティスキーム "api_key" が components.securitySchemes に宣言されていません。
20:5 警告 セキュリティスキーム "apiKey" はどこからも参照されていません。
確認する規則
| 規則 | 段階 | 根拠 |
|---|---|---|
| 必須・未知のフィールド、型、パラメーターやレスポンスの形 | エラー | バージョンごとの公式 JSON Schema |
| 3.1・3.2 のスキーマオブジェクト | エラー | JSON Schema 2020-12 のメタスキーマ |
ローカルの $ref の参照先が存在する(追加した別ファイルも含む) | エラー | Reference Object |
パステンプレートと in: path の対応、パラメーター名だけが違うパス、重複したパラメーター・operationId・タグ名 | エラー | Paths Object、Parameter Object の MUST |
| セキュリティ要件のスキームが宣言済み | エラー | Security Requirement Object |
| サーバー変数のデフォルト値が enum に含まれる | 3.1 以降はエラー、3.0 は警告 | Server Variable Object |
真偽値の exclusiveMinimum / exclusiveMaximum と同じオブジェクトに minimum / maximum がない(スキーマオブジェクト。2.0 では body 以外の Parameter・Header・Items Object も) | 2.0 はエラー、3.0 は警告 | 2.0 は JSON Schema draft 4(§5.1.2.1・§5.1.3.1:両方を書く MUST)、3.0 の Wright draft 00 はこの MUST を削除しており、単独では効果がないだけです。公式スキーマ、Redocly CLI 2.57.0、Spectral 6.17.0 はこの点を単独では確認しません |
サンプル値とスキーマの一致、未使用のコンポーネント、未定義・未使用のサーバー変数、パスのクエリ文字列、3.1 の nullable | 警告 | 仕様の SHOULD と、Redocly・Spectral も報告するよくある誤り |
YAML は YAML 1.2 の Core Schema で読みます。引用符なしの version: 2026-10-02 は文字列のままです。同じ階層に同じキーが 2 回あると、JSON でも行番号付きの構文エラーになります。マージキー(<<: *anchor)も使えます。
他のツールとの違い
2026-10-02 に、同じテスト用の仕様書で比べました。中身は、宣言していないパスパラメーター、宣言していないセキュリティスキーム、パラメーター名だけが違う 2 つのパス、プロパティの required: true の 4 つのエラーと、引用符なしの日付の info.version です。
- Redocly CLI 2.57.0 と Spectral 6.17.0 は 4 件とも検出しました。summary や 4XX レスポンスなどのスタイル規則も多数出ます。swagger-parser 13.1.0 は有効と判定しました。
- Swagger Editor 5.8.9(editor.swagger.io)はブラウザ内で動き、パスパラメーターと
requiredは検出しましたが、同じテンプレートのパスと未宣言のスキームは出ませんでした。 - アサリツールズの OpenAPI(Swagger)検証ツールは通信なしで動きますが、
"200"と"204"を「無効なステータスコードです」と誤って報告し、4 件のエラーはどれも出ませんでした。
制限
- 命名や説明文などのスタイル規則は扱いません。チームのルールは、このツールの後で Redocly CLI や Spectral を使ってください。
$refの URL は取得せず、情報として表示するだけで確認しません。不足しているのがファイルへの参照なら、そのファイルを追加してください。アンカー参照(#name)は確認しません。- 非常に大きな仕様書では、サンプル値の確認を 4 秒で打ち切り、その旨を表示します。2,097,152 文字を超える入力は「検証」を押したときに確認し、合計 50 MiB を超えるファイルは読み込みません。
- 開いたファイルが 512 K 文字を超えるときは、全文を検証しますが、編集欄には最大 300 行・49,152 文字を読み取り専用で表示します。約 10 MB を編集欄に入れるとページが 0.5 秒ほど止まるためです。行番号を押すと表示がその行に移ります。「全文をコピー」「ダウンロード」「全文を編集(遅くなります)」で全体を扱えます。自分で大量のテキストを編集欄に貼り付けた場合は、引き続きページが止まります。
- YAML は js-yaml 4.3.2 で読みます。ネストが 100 階層を超える文書、マージキーで処理するマッピングとキーが合計 10,000 個を超える文書、1 つのマージキーに 100 個を超えるマッピングを並べた文書は止まり、エラーに上限と行が出ます。
関連ツール:型を生成する OpenAPI → TypeScript ジェネレーター、リクエストの JSON を確かめる JSON Schema バリデーター、インデントの誤りを探す YAML バリデーター。
FAQ
対応しているバージョンは?
Swagger 2.0 と OpenAPI 3.0・3.1・3.2 です。swagger または openapi フィールドを読み、そのバージョンの公式 JSON Schema で検証します。Swagger 2.0 は OpenAPI Initiative のリポジトリにあるスキーマ、3.0(2024-10-18)・3.1(2026-08-03)・3.2(2026-08-30)は spec.openapis.org が公開しているスキーマです。
仕様書はアップロードされますか?
されません。解析とすべての確認はブラウザ内(Web Worker、Worker を起動できない場合はページ上)で行い、仕様書をアップロードせず、ブラウザのストレージにも保存しません。$ref の URL は取得せず、「他のファイル」に追加したファイルもページの中だけで使います。テキストやファイルの編集確定、ファイル操作、「サンプル」「検証」による確認が完了すると、ツール名と、検証エラーの有無に応じた validate_success または validate_error だけを記録します。入力中も結果は更新しますが利用イベントは記録しません。復元や初期表示、同じ検証結果、Worker の失敗、古い応答ではイベントを増やしません。仕様書の内容は含みません。
$ref で分割したファイルもまとめて確認できますか?
できます。複数のファイルやフォルダをまとめて開くか、「他のファイル」に $ref と同じパス(例:schemas/pet.yaml)で追加してください。参照をファイルをまたいで解決し、問題はその記述があるファイルと行に表示します。追加していないファイルや URL への参照は「情報」に出ます。
エラーと警告の違いは?
エラーは仕様の MUST や公式スキーマに反するもので、他のツールが読み込みを拒む可能性があります。警告は SHOULD の規則とよくある誤り(サンプル値がスキーマと合わない、使われていないコンポーネント、未定義のサーバー変数など)です。情報には確認しなかった内容と注意すべき値を出します。
info.version: 2024-01-15 がここでは通るのに、ほかのツールでエラーになるのはなぜですか?
このツールは YAML を YAML 1.2 の Core Schema で読みます(Redocly CLI、Spectral、swagger-parser と同じです)。そのため引用符なしの日付も文字列のままです。YAML 1.1 のタイムスタンプ規則で読むパーサーは日付に変換し、スキーマが info.version を拒否します。"2024-01-15" のように引用符で囲めば、どのパーサーでも文字列として読まれます。
e-Gov 法令API の仕様書で、XML のサンプル値が警告にならないのはなぜですか?
OpenAPI 3.x の Example Object(examples の各値)では、JSON や YAML で自然に表せないメディアタイプのサンプルは value に文字列で書くと定めています。application/xml などの文字列サンプルはシリアライズ済みの本文とみなし、スキーマとは比べません。e-Gov 法令API Version 2 の lawapi-v2.yaml では XML のサンプル 16 件がこの形で書かれており、Spectral 6.17.0 はエラー、Redocly CLI 2.57.0 は警告にしますが、このツールの警告は JSON のサンプル値 5 件だけです。