Yazmak için YAML
Uzun açıklamalar YAML blok metni olarak daha iyi okunur ve yorumlar belirtime inceleyenler için not eklemenizi sağlar.
API belirtimlerini $ref yollarını veya yanıt kodlarını bozmadan JSON ile YAML arasında dönüştürün.
Çıktının her satırı, varsayılan biçimlendirmeyle, içerdiği değerin yolunun yanında. Yolu kopyalamak için bir satıra tıklayın.
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).
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.
{
"paths": {
"/pets/{id}": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pet"
}
}
}
},
"4XX": {
"description": "Client error"
}
}
}
}
}
} 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.
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.
# Lint the converted spec (OpenAPI 3.x and Swagger 2.0)
npx @redocly/cli lint openapi.yaml Uzun açıklamalar YAML blok metni olarak daha iyi okunur ve yorumlar belirtime inceleyenler için not eklemenizi sağlar.
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.
İ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.
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.
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.
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.
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.
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.
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.