Czy to narzędzie obsługuje OpenAPI 3.1?

Tak. Obsługuje definicje OpenAPI 3.1, 3.0 i Swagger 2.0. Narzędzie konwertuje podstawową strukturę bez zmiany wersji specyfikacji.

Czy moja dokumentacja API zostanie zachowana w tajemnicy?

Tak. Konwersja odbywa się w całości w Twojej przeglądarce, przy użyciu JavaScript. Żadne dane dokumentu nie są wysyłane na nasze serwery ani przechowywane zewnętrznie.

Co dzieje się z komentarzami YAML podczas konwersji?

JSON nie obsługuje komentarzy, więc wszelkie komentarze w Twoim źródłowym pliku YAML zostaną usunięte podczas konwersji do JSON. Są one zachowywane, jeśli po prostu formatujesz YAML.

Czy wynik jest walidowany względem schematu OpenAPI?

Narzędzie sprawdza poprawność składni `YAML` i `JSON` podczas procesu konwersji. Do pełnej walidacji na poziomie schematu zalecamy użycie dedykowanego lintera OpenAPI.

Formatowanie i Kodowanie

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

Notka redakcyjna

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

Ten szczegółowy rozdział jest obecnie dostępny tylko w języku angielskim. Narzędzie konwersji powyżej działa w Twoim języku; długi artykuł objaśniający nie został jeszcze przetłumaczony.

Często zadawane pytania

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.

Ludzie wyszukują również

Powiązane narzędzia

More in this room.

Zobacz wszystkie w Formatowanie i Kodowanie