Bu araç OpenAPI 3.1'i destekliyor mu?

Evet. OpenAPI 3.1, 3.0 ve Swagger 2.0 tanımlarını destekler. Araç, belirtim sürümünü değiştirmeden temel yapıyı dönüştürür.

API belgelerim gizli kalacak mı?

Evet. Dönüştürme tamamen tarayıcınızda JavaScript kullanılarak gerçekleşir. Hiçbir belge verisi sunucularımıza gönderilmez veya harici olarak depolanmaz.

Dönüştürme sırasında YAML yorumlarına ne olur?

JSON yorumları desteklemez, bu nedenle YAML kaynağınızdaki tüm yorumlar JSON'a dönüştürülürken kaldırılacaktır. Yalnızca YAML'ı biçimlendiriyorsanız korunurlar.

Çıktı OpenAPI şemasına göre doğrulanıyor mu?

Araç, dönüştürme işlemi sırasında geçerli `YAML` ve `JSON` sözdizimini kontrol eder. Tam şema düzeyinde doğrulama için özel bir OpenAPI linter kullanmanızı öneririz.

Biçimlendiriciler ve Kod

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

Editörün notu

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

Bu ayrıntılı bölüm şu anda yalnızca İngilizce olarak sunulmaktadır. Yukarıdaki dönüştürme aracı sizin dilinizde çalışır; uzun açıklayıcı yazı henüz çevrilmemiştir.

Sıkça sorulan sorular

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.

İnsanlar ayrıca şunları arar

İlgili araçlar

More in this room.

Tümünü gör Biçimlendiriciler ve Kod