OpenAPI och Swagger JSON till YAML

Konvertera API-specifikationer mellan JSON och YAML utan att förstöra $ref-sökvägar eller svarskoder.

Utdataalternativ

JSONindata

Tom

YAMLutdata

YAML-utdata visas här

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.

Läs in från URL

Filen hämtas direkt av din webbläsare, så servern måste tillåta cross-origin-förfrågningar.

Kortkommandon

Ctrl / ⌘ + Enter Konvertera nu
Ctrl / ⌘ + S Ladda ner utdata
Alt + Shift + C Kopiera utdata
Alt + Shift + F Reparera och formatera JSON-indata
Alt + Shift + S Byt riktning
Alt + Shift + T Växla mellan kod-, träd- och kartvy
Ctrl / ⌘ + Z Ångra, även Formatera, Reparera och Rensa
Esc Lämna helskärm
Textstorlek i redigeraren

$ref-pekare och svarskoder förblir giltiga

Två detaljer förstör handkonverterade specifikationer: ett # som inleder en YAML-kommentar, och statuskoder som blir heltal. Båda hanteras.

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

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.

Linta resultatet

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.

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

JSON eller YAML för API-specifikationer?

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.

JSON för verktyg

Kodgeneratorer, gateways och SDK:er läser ofta in JSON snabbast, och många serverar specifikationen på /openapi.json.

Samma dokument

Båda formaten beskriver samma API. Konvertera fritt åt båda hållen; ingenting i specifikationen går förlorat.

Fler verktyg

Konverterare, validerare och steg-för-steg-guider för alla ställen där JSON och YAML möts.

Vanliga frågor

Hur konverterar jag en OpenAPI-fil i JSON till YAML?

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.

Fungerar det för Swagger 2.0 lika väl som för OpenAPI 3?

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.

Varför står $ref: '#/components/...' inom citattecken?

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.

Varför skrivs svarskoder som '200'?

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.

Hur konverterar jag OpenAPI-YAML tillbaka till JSON?

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.