OpenAPI ও Swagger JSON থেকে YAML

$ref পাথ বা রেসপন্স কোড না ভেঙে API স্পেক JSON ও YAML-এর মধ্যে রূপান্তর করুন।

আউটপুট অপশন

JSONইনপুট

খালি

YAMLআউটপুট

YAML আউটপুট এখানে দেখা যাবে

সম্পূর্ণভাবে আপনার ব্রাউজারে চলে: কিছুই আপলোড হয় না। স্প্যাম ও বট ঠেকাতে ন্যায্য ব্যবহারের সীমা প্রযোজ্য (প্রতি ইনপুটে 5 MB, রূপান্তরের হার সীমিত)।

URL থেকে লোড করুন

ফাইলটি সরাসরি আপনার ব্রাউজার থেকে আনা হয়, তাই সার্ভারে ক্রস-অরিজিন অনুরোধের অনুমতি থাকতে হবে।

কিবোর্ড শর্টকাট

Ctrl / ⌘ + Enter এখনই রূপান্তর করুন
Ctrl / ⌘ + S আউটপুট ডাউনলোড করুন
Alt + Shift + C আউটপুট কপি করুন
Alt + Shift + F JSON ইনপুট ঠিক ও ফরম্যাট করুন
Alt + Shift + S দিক অদলবদল করুন
Alt + Shift + T কোড, ট্রি ও ম্যাপ ভিউয়ের মধ্যে বদলান
Ctrl / ⌘ + Z আনডু করুন, ফরম্যাট, ঠিক করুন ও মুছুন সহ
Esc ফুল স্ক্রিন থেকে বেরোন
এডিটরের টেক্সটের আকার

$ref পয়েন্টার ও রেসপন্স কোড বৈধ থাকে

হাতে রূপান্তর করা স্পেক দুটি কারণে ভাঙে: একটি # যা YAML কমেন্ট শুরু করে, আর স্ট্যাটাস কোড যা পূর্ণসংখ্যায় পরিণত হয়। দুটিই সামলানো হয়।

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

হাতে লেখা, কোট ছাড়া-তে বদলে দেখুন $ref কীভাবে null হয়ে যায় এবং ওয়াইল্ডকার্ড হোস্ট পার্স হতে ব্যর্থ হয়।

ফলাফল লিন্ট করুন

রূপান্তরের পর কেবল সিনট্যাক্স নয়, স্পেকটিই যাচাই করতে একটি লিন্টার চালান। এখানে সম্পাদনার সময়ই প্রতিটি লোকাল $ref যাচাই হয়।

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

API স্পেকের জন্য JSON নাকি YAML?

লেখার জন্য YAML

লম্বা বিবরণ YAML ব্লক টেক্সটে বেশি পড়ার উপযোগী, আর কমেন্ট দিয়ে রিভিউয়ারদের জন্য স্পেকে টীকা দেওয়া যায়।

টুলিংয়ের জন্য JSON

কোড জেনারেটর, গেটওয়ে ও SDK প্রায়ই JSON সবচেয়ে দ্রুত লোড করে, আর অনেকে স্পেকটি /openapi.json-এ সার্ভ করে।

একই ডকুমেন্ট

দুটি ফরম্যাটই একই API বর্ণনা করে। যেকোনো দিকে স্বাধীনভাবে রূপান্তর করুন; স্পেকের কিছুই হারায় না।

আরও টুল

যেখানেই JSON ও YAML একসঙ্গে আসে, তার জন্য কনভার্টার, ভ্যালিডেটর ও ধাপে ধাপে গাইড।

সচরাচর জিজ্ঞাসিত প্রশ্ন

OpenAPI JSON ফাইলকে YAML-এ কীভাবে রূপান্তর করব?

openapi.json পেস্ট বা আপলোড করুন এবং ডান দিকের প্যান থেকে YAML কপি করুন, অথবা openapi.yaml হিসেবে ডাউনলোড করুন। কাঠামো, $ref পয়েন্টার, উদাহরণ ও বিবরণ হুবহু থাকে।

এটি কি OpenAPI 3-এর পাশাপাশি Swagger 2.0-তেও কাজ করে?

হ্যাঁ। কনভার্টার ডকুমেন্টের কাঠামোর ওপর কাজ করে, তাই Swagger 2.0, OpenAPI 3.0 ও OpenAPI 3.1 স্পেক দুই দিকেই একইভাবে রূপান্তরিত হয়।

$ref: '#/components/...' কেন কোট করা হয়?

YAML-এ স্পেসের পরে # এলে তা কমেন্ট শুরু করে। কোট ছাড়া $ref:-এর পরের সবকিছু কমেন্ট হিসেবে গণ্য হতো এবং রেফারেন্সটি খালি থাকত। কনভার্টার এটি স্বয়ংক্রিয়ভাবে কোট করে।

রেসপন্স কোড কেন '200' হিসেবে লেখা হয়?

OpenAPI-তে রেসপন্স কোড স্ট্রিং কী হতে হয়। YAML-এ কোটবিহীন 200 একটি পূর্ণসংখ্যা; বেশিরভাগ টুল এটি গ্রহণ করে, কিন্তু কঠোর ভ্যালিডেটর করে না। কোট করলে স্পেক সব জায়গায় বৈধ থাকে।

OpenAPI YAML-কে আবার JSON-এ কীভাবে রূপান্তর করব?

এডিটরের ওপরের টগল দিয়ে দিক বদলে YAML → JSON করুন, অথবা YAML থেকে JSON কনভার্টার ব্যবহার করুন। YAML-এর অ্যাঙ্করগুলো প্রসারিত হয়, কারণ JSON-এ এ ধরনের রেফারেন্স নেই।