YAML för att skriva
Långa beskrivningar blir mer lättlästa som blocktext i YAML, och kommentarer låter dig anteckna specifikationen för granskare.
Konvertera API-specifikationer mellan JSON och YAML utan att förstöra $ref-sökvägar eller svarskoder.
Varje rad i utdata, med standardformatering, bredvid sökvägen till värdet den innehåller. Klicka på en rad för att kopiera sökvägen.
Körs helt i din webbläsare: ingenting laddas upp. Gränser för rimlig användning gäller (5 MB per indata, begränsat antal konverteringar) för att förhindra spam och botar.
Två detaljer förstör handkonverterade specifikationer: ett # som inleder en YAML-kommentar, och statuskoder som blir heltal. Båda hanteras.
{
"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 Byt till För hand, utan citattecken för att se hur $ref blir null och hur värdnamnet med jokertecken inte går att tolka.
Kör en linter efter konverteringen för att kontrollera själva specifikationen, inte bara syntaxen. Här kontrolleras varje lokal $ref medan du redigerar.
# Lint the converted spec (OpenAPI 3.x and Swagger 2.0)
npx @redocly/cli lint openapi.yaml Långa beskrivningar blir mer lättlästa som blocktext i YAML, och kommentarer låter dig anteckna specifikationen för granskare.
Kodgeneratorer, gateways och SDK:er läser ofta in JSON snabbast, och många serverar specifikationen på /openapi.json.
Båda formaten beskriver samma API. Konvertera fritt åt båda hållen; ingenting i specifikationen går förlorat.
Konverterare, validerare och steg-för-steg-guider för alla ställen där JSON och YAML möts.
Klistra in eller ladda upp openapi.json och kopiera YAML-koden från den högra panelen, eller ladda ner den som openapi.yaml. Strukturen, $ref-pekarna, exemplen och beskrivningarna behålls exakt.
Ja. Konverteraren arbetar på dokumentets struktur, så specifikationer i Swagger 2.0, OpenAPI 3.0 och OpenAPI 3.1 konverteras på samma sätt, åt båda hållen.
I YAML inleder # en kommentar när det följer efter ett blanksteg. Utan citattecken skulle allt efter $ref: behandlas som en kommentar och referensen bli tom. Konverteraren lägger till citattecknen automatiskt.
OpenAPI kräver att svarskoder är strängnycklar. Ett 200 utan citattecken är ett heltal i YAML; de flesta verktyg accepterar det, men strikta validerare gör det inte. Med citattecken förblir specifikationen giltig överallt.
Byt riktning till YAML → JSON med reglaget ovanför redigeraren, eller använd YAML till JSON-konverteraren. Ankare i YAML-koden expanderas, eftersom JSON saknar den sortens referenser.