Cet outil supporte-t-il OpenAPI 3.1?

Oui. Il supporte les définitions OpenAPI 3.1, 3.0 et Swagger 2.0. L'outil convertit la structure sous-jacente sans altérer la version de la spécification.

Ma documentation API restera-t-elle privée?

Oui. La conversion se fait entièrement dans votre navigateur à l'aide de JavaScript. Aucune donnée de document n'est envoyée à nos serveurs ou stockée en externe.

Qu'advient-il des commentaires YAML pendant la conversion?

JSON ne prend pas en charge les commentaires, donc tout commentaire dans votre source YAML sera supprimé lors de la conversion en JSON. Ils sont conservés si vous formatez simplement du YAML.

Le résultat est-il validé par rapport au schéma OpenAPI?

L'outil vérifie la syntaxe `YAML` et `JSON` valide pendant le processus de conversion. Pour une validation complète au niveau du schéma, nous recommandons d'utiliser un linter OpenAPI dédié.

Formateurs & Code

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

Note de la rédaction

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

Ce chapitre approfondi n'est actuellement disponible qu'en anglais. L'outil de conversion ci-dessus fonctionne dans votre langue ; le long article explicatif n'a pas encore été traduit.

Questions fréquentes

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.

Les internautes recherchent aussi

Outils similaires

More in this room.

Tout voir dans Formateurs & Code