เครื่องมือนี้รองรับ OpenAPI 3.1 หรือไม่?

ใช่ รองรับ OpenAPI 3.1, 3.0 และ Swagger 2.0 เครื่องมือนี้จะแปลงโครงสร้างพื้นฐานโดยไม่เปลี่ยนแปลงเวอร์ชันของข้อมูลจำเพาะ

เอกสาร API ของฉันจะยังคงเป็นส่วนตัวหรือไม่?

ใช่ การแปลงเกิดขึ้นทั้งหมดในเบราว์เซอร์ของคุณโดยใช้ JavaScript ไม่มีข้อมูลเอกสารใดถูกส่งไปยังเซิร์ฟเวอร์ของเราหรือจัดเก็บภายนอก

เกิดอะไรขึ้นกับความคิดเห็น YAML ระหว่างการแปลง?

JSON ไม่รองรับความคิดเห็น ดังนั้นความคิดเห็นใดๆ ในแหล่งที่มา YAML ของคุณจะถูกลบออกเมื่อแปลงเป็น JSON แต่จะยังคงอยู่ถ้าคุณเพียงแค่จัดรูปแบบ YAML

ผลลัพธ์ได้รับการตรวจสอบตาม Schema ของ OpenAPI หรือไม่?

เครื่องมือนี้จะตรวจสอบไวยากรณ์ `YAML` และ `JSON` ที่ถูกต้องระหว่างกระบวนการแปลง สำหรับการตรวจสอบระดับ Schema เต็มรูปแบบ เราขอแนะนำให้ใช้ OpenAPI linter โดยเฉพาะ

ตัวจัดรูปแบบและโค้ด

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

หมายเหตุจากบรรณาธิการ

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

บทเชิงลึกนี้มีให้บริการเฉพาะภาษาอังกฤษในขณะนี้ เครื่องมือแปลงด้านบนทำงานในภาษาของคุณ บทความอธิบายแบบยาวยังไม่ได้แปล

คำถามที่พบบ่อย

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.

ผู้คนยังค้นหา

เครื่องมือที่เกี่ยวข้อง

More in this room.

ดูทั้งหมดใน ตัวจัดรูปแบบและโค้ด