Apakah alat ini mendukung OpenAPI 3.1?

Ya. Alat ini mendukung definisi OpenAPI 3.1, 3.0, dan Swagger 2.0. Alat ini mengkonversi struktur dasar tanpa mengubah versi spesifikasi.

Apakah dokumentasi API saya akan tetap pribadi?

Ya. Konversi dilakukan sepenuhnya di browser Anda menggunakan JavaScript. Tidak ada data dokumen yang dikirim ke server kami atau disimpan secara eksternal.

Apa yang terjadi dengan komentar YAML selama konversi?

JSON tidak mendukung komentar, jadi setiap komentar di sumber YAML Anda akan dihilangkan saat mengkonversi ke JSON. Komentar akan dipertahankan jika Anda hanya memformat YAML.

Apakah output divalidasi terhadap skema OpenAPI?

Alat ini memeriksa validitas sintaksis `YAML` dan `JSON` selama proses konversi. Untuk validasi tingkat skema penuh, kami merekomendasikan penggunaan linter OpenAPI khusus.

Formatter & Kode

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

Catatan editor

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

Bab mendalam ini saat ini hanya tersedia dalam bahasa Inggris. Alat konversi di atas berfungsi dalam bahasa Anda; artikel penjelasan panjangnya belum diterjemahkan.

Pertanyaan yang sering diajukan

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.

Orang juga mencari

Fitur terkait

More in this room.

Lihat semua di Formatter & Kode