OpenAPI ve Swagger: JSON'dan YAML'a

API belirtimlerini $ref yollarını veya yanıt kodlarını bozmadan JSON ile YAML arasında dönüştürün.

Çıktı seçenekleri

JSONgirdi

Boş

YAMLçıktı

YAML çıktısı burada görünür

Tamamen tarayıcınızda çalışır: hiçbir şey yüklenmez. Spam ve botları önlemek için adil kullanım sınırları geçerlidir (girdi başına 5 MB, hız sınırlı dönüştürmeler).

URL'den yükle

Dosya doğrudan tarayıcınız tarafından alınır; bu nedenle sunucunun çapraz kaynaklı isteklere izin vermesi gerekir.

Klavye kısayolları

Ctrl / ⌘ + Enter Şimdi dönüştür
Ctrl / ⌘ + S Çıktıyı indir
Alt + Shift + C Çıktıyı kopyala
Alt + Shift + F JSON girdisini onar ve biçimlendir
Alt + Shift + S Yönü değiştir
Alt + Shift + T Kod, ağaç ve harita görünümleri arasında geçiş yap
Ctrl / ⌘ + Z Geri al (Biçimlendir, Onar ve Temizle dahil)
Esc Tam ekrandan çık
Düzenleyici metin boyutu

$ref işaretçileri ve yanıt kodları geçerli kalır

Elle dönüştürülen belirtimleri iki ayrıntı bozar: bir YAML yorumu başlatan # ve tamsayıya dönüşen durum kodları. İkisi de ele alınır.

openapi.json
{
  "paths": {
    "/pets/{id}": {
      "get": {
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              }
            }
          },
          "4XX": {
            "description": "Client error"
          }
        }
      }
    }
  }
}
openapi.yaml
paths:
  /pets/{id}:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        4XX:
          description: Client error

$ref değerinin null'a dönüştüğünü ve joker karakterli ana bilgisayarın ayrıştırılamadığını görmek için Elle, tırnaksız seçeneğine geçin.

Sonucu lint'leyin

Dönüştürdükten sonra yalnızca sözdizimini değil belirtimin kendisini de kontrol etmek için bir linter çalıştırın. Burada her yerel $ref, siz düzenledikçe kontrol edilir.

bash
# Lint the converted spec (OpenAPI 3.x and Swagger 2.0)
npx @redocly/cli lint openapi.yaml

API belirtimleri için JSON mu, YAML mı?

Yazmak için YAML

Uzun açıklamalar YAML blok metni olarak daha iyi okunur ve yorumlar belirtime inceleyenler için not eklemenizi sağlar.

Araçlar için JSON

Kod üreteçleri, ağ geçitleri ve SDK'lar JSON'u genellikle en hızlı yükler ve birçoğu belirtimi /openapi.json adresinde sunar.

Aynı belge

İki biçim de aynı API'yi tanımlar. Her iki yönde de özgürce dönüştürün; belirtimden hiçbir şey kaybolmaz.

Diğer araçlar

JSON ve YAML'ın buluştuğu her yer için dönüştürücüler, doğrulayıcılar ve adım adım kılavuzlar.

Sıkça sorulan sorular

Bir OpenAPI JSON dosyasını YAML'a nasıl dönüştürürüm?

openapi.json dosyasını yapıştırın veya yükleyin ve YAML'ı sağdaki bölmeden kopyalayın ya da openapi.yaml olarak indirin. Yapı, $ref işaretçileri, örnekler ve açıklamalar aynen korunur.

OpenAPI 3'ün yanı sıra Swagger 2.0 için de çalışıyor mu?

Evet. Dönüştürücü belge yapısı üzerinde çalışır; bu yüzden Swagger 2.0, OpenAPI 3.0 ve OpenAPI 3.1 belirtimleri her iki yönde de aynı şekilde dönüştürülür.

$ref: '#/components/...' neden tırnaklı?

YAML'da # bir boşluktan sonra geldiğinde yorum başlatır. Tırnak olmadan $ref: sonrasındaki her şey yorum sayılır ve referans boş kalır. Dönüştürücü bunu otomatik olarak tırnaklar.

Yanıt kodları neden '200' olarak yazılıyor?

OpenAPI, yanıt kodlarının dize anahtar olmasını gerektirir. Tırnaksız 200, YAML'da bir tamsayıdır; çoğu araç bunu kabul eder ama katı doğrulayıcılar etmez. Tırnaklamak belirtimi her yerde geçerli tutar.

OpenAPI YAML'ını tekrar JSON'a nasıl dönüştürürüm?

Düzenleyicinin üstündeki düğmeyle yönü YAML → JSON olarak değiştirin veya YAML'dan JSON'a dönüştürücüyü kullanın. JSON'da bu türden referanslar olmadığı için YAML'daki çapalar genişletilir.