このツールはOpenAPI 3.1をサポートしていますか？

はい。OpenAPI 3.1、3.0、Swagger 2.0の定義をサポートしています。このツールは、仕様バージョンを変更せずに基礎となる構造を変換します。

APIドキュメントはプライベートに保たれますか？

はい。変換はJavaScriptを使用してブラウザ内で完全に実行されます。ドキュメントデータが当社のサーバーに送信されたり、外部に保存されたりすることはありません。

変換中にYAMLコメントはどうなりますか？

JSONはコメントをサポートしていないため、YAMLソース内のコメントはJSONに変換される際に削除されます。YAMLをフォーマットするだけの場合は保持されます。

出力はOpenAPIスキーマに対して検証されますか？

このツールは、変換プロセス中に有効な`YAML`および`JSON`構文をチェックします。完全なスキーマレベルの検証には、専用のOpenAPIリンターを使用することをお勧めします。

フォーマッター＆コード

OpenAPI 3.1 YAML ⇄ JSON

Convert OpenAPI specs between YAML and JSON.

Runs in your browser

OpenAPI YAML · source

lines: 42chars: 924size: 924 B

JSON · result

{
  "openapi": "3.0.3",
  "info": {
    "title": "AnytimeConvert API",
    "version": "1.0.0"
  },
  "paths": {
    "/tools": {
      "get": {
        "summary": "List all tools",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Tool"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/tools/{slug}": {
      "get": {
        "summary": "Get a tool by slug",
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tool"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Tool": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": "string"
          }
        },
        "required": [
          "slug",
          "name",
          "category"
        ]
      }
    }
  }
}

lines: 79chars: 1576size: 1.5 KB

live

編集者注

Understanding · Same spec, two file formats — pick by audience.

この詳細な解説章は現在、英語版のみで提供されています。上の変換ツールはあなたの言語で動作しますが、長文の解説記事はまだ翻訳されていません。

よくある質問

Quick answers.

›Does this tool support OpenAPI 3.1?

Yes. It supports OpenAPI 3.1, 3.0, and Swagger 2.0 definitions. The tool converts the underlying structure without altering the specification version.

›Will my API documentation be kept private?

Yes. The conversion happens entirely in your browser using JavaScript. No document data is sent to our servers or stored externally.

›What happens to YAML comments during conversion?

JSON does not support comments, so any comments in your YAML source will be stripped when converting to JSON. They are preserved if you are simply formatting YAML.

›Is the output validated against the OpenAPI schema?

The tool checks for valid `YAML` and `JSON` syntax during the conversion process. For full schema-level validation, we recommend using a dedicated OpenAPI linter.

他の人はこちらも検索しています

More in this room.

すべて表示フォーマッター＆コード