OpenAPI / Swagger Formatter
Format and validate OpenAPI / Swagger specs (JSON or YAML) and count paths and operations.
Yeh ek local tool hai: yeh poori tarah aapke browser mein chalta hai. Jo OpenAPI ya Swagger spec aap paste karte hain woh kabhi aapke device se bahar nahi jaati — ArrayKit ya kisi server ko kuch upload nahi hota.
YAML aur JSON ke beech convert karein
OpenAPI / Swagger Formatter ke baare mein
ArrayKit OpenAPI formatter OpenAPI aur Swagger specifications ko ya to JSON ya YAML mein beautify aur validate karta hai, sab aapke browser ke andar. Ek spec paste karein aur yeh document parse karta hai, detected version (OpenAPI 3.x ya Swagger 2.0), API title report karta hai, aur ginta hai ki yeh kitne paths aur operations define karta hai, phir saaf, consistently indent kiya gaya JSON ya YAML re-emit karta hai. Yeh un backend aur API developers, technical writers aur platform teams ke liye bana hai jinhe ek hand-edited contract tidy karne, JSON aur YAML ke beech convert karne, ya ek spec ko commit karne se pehle ya Swagger UI, code generators, ya ek gateway ko dene se pehle sanity-check karne ka ek tez tareeka chahiye. Kyunki request building aur parsing locally hota hai, aap internal ya unreleased API definitions ko bina kisi server ko bheje format kar sakte hain. Use malformed YAML pakadne, operation counts confirm karne, aur ek repo mein formatting standardize karne ke liye use karein.
Features
- JSON aur YAML dono input accept karta hai — JSON valid YAML hai, isliye dono parse hote hain
- Spec version detect aur label karta hai: OpenAPI 3.x ya Swagger 2.0
- API title plus paths aur operations ka ek live count report karta hai
- Aath HTTP operations ginta hai (get, put, post, delete, options, head, patch, trace)
- Output ko pretty-printed JSON aur 2-space YAML ke beech toggle karein
- Jab document malformed ho to underlying message ke saath parse errors surface karta hai
- Warn karta hai jab koi openapi ya swagger field maujood na ho taaki unknown specs alag dikhein
- Formatted result ko openapi.json ya openapi.yaml ke roop mein download karein
OpenAPI / Swagger Formatter kaise use karein
- Apni OpenAPI ya Swagger spec (JSON ya YAML) input panel mein paste karein
- Toolbar mein JSON / YAML toggle se output format chunein
- Version, title, path count aur operation count ke liye summary banner padhein
- Formatted spec copy karein ya use openapi.json ya openapi.yaml ke roop mein download karein
Example
Input
openapi: 3.0.3
info: { title: Example API, version: 1.0.0 }
paths:
/users:
get: { summary: List users, responses: { '200': { description: OK } } }
post: { summary: Create user, responses: { '201': { description: Created } } }
Output
openapi: 3.0.3
info:
title: Example API
version: 1.0.0
paths:
/users:
get:
summary: List users
responses:
'200':
description: OK
post:
summary: Create user
responses:
'201':
description: Created
Ek minimal OpenAPI 3.0 spec — formatter 'OpenAPI 3.0.3 · Example API · 1 path · 2 operations' report karta hai.
Common errors aur troubleshooting
- Summary 'Unknown — no openapi/swagger field' dikhata hai. — Ek top-level openapi: 3.x.x (ya swagger: '2.0') field add karein; iske bina version detect nahi ho sakta halaanki document phir bhi format hota hai.
- Ek YAML parse error dikhta hai, aksar bad indentation ya ek tab character ke baare mein. — YAML indentation-sensitive hai aur tabs ko mana karta hai — tabs ko spaces se replace karein aur keys ko consistently align karein, phir dobara paste karein.
- Operation count expected se kam dikhta hai. — Sirf aath standard HTTP methods ginti jaati hain; x-amazon-apigateway-integration jaise vendor extensions aur parameters/servers entries operations nahi hain.
- Paste karne ke baad 'The document is empty or not an object'. — Input ek scalar ya null par parse hua — pakka karein ki aapne poora spec object paste kiya, ek single string ya ek partial fragment nahi.
Aksar pooche jaane wale sawaal
- OpenAPI / Swagger formatter kya hai?
- Yeh ek tool hai jo ek OpenAPI 3.x ya Swagger 2.0 API specification parse karta hai aur use saaf, consistently indent kiye gaye JSON ya YAML ke roop mein re-emit karta hai, saath hi version aur paths aur operations ki sankhya report karta hai taaki aap ek spec jaldi review aur standardize kar sakein.
- Kya yeh JSON aur YAML dono specs support karta hai?
- Haan. Kyunki JSON khud valid YAML hai, aap dono format paste kar sakte hain. Formatted output kaise emit ho yeh chunne ke liye JSON / YAML toggle use karein, jo aapko ek spec ko ek format se doosre mein convert karne deta hai.
- Kya yeh meri spec ko OpenAPI schema ke khilaaf poori tarah validate karta hai?
- Yeh validate karta hai ki document well-formed JSON ya YAML ke roop mein parse hota hai aur version, title, paths aur operations detect karta hai. Yeh har field ki poori JSON Schema validation nahi chalata, isliye yeh ek operation ke andar deep ek missing required property flag nahi karega.
- Yeh kaunse versions pehchanta hai?
- Yeh openapi field ke through OpenAPI 3.x aur swagger field ke through Swagger 2.0 label karta hai. In fields mein se ek ke bina koi bhi document format to hota hai lekin ek unknown version ke roop mein mark hota hai.
- Kya meri API spec kahin upload hoti hai?
- Nahi. Parsing, validation aur formatting poori tarah aapke browser mein chalte hain. Jo spec aap paste karte hain woh kabhi aapke device se bahar nahi jaati aur ArrayKit ko kuch upload nahi hota, isliye internal ya unreleased API contracts private rehte hain.
- Kya main formatted result download kar sakta hoon?
- Haan. Formatted spec ko aapke chune gaye output format ke hisaab se openapi.json ya openapi.yaml ke roop mein copy ya download kiya ja sakta hai.
Related tools
- YAML ↔ JSON — YAML ko JSON mein aur wapas convert karein.
- JSON Formatter — JSON ko beautify, minify aur validate karein, error ki location ke saath.
- GraphQL Formatter — GraphQL queries aur schemas format ya minify karein, syntax validate karein aur operations extract karein.
- XML Formatter — XML ko beautify, minify aur validate karein, aur XML ↔ JSON convert karein.
- API Client — HTTP requests bhejein, headers aur params banayein aur responses inspect karein; aapki aakhri 25 save hoti hain.
- cURL se Fetch — Ek curl command ko JavaScript fetch() call mein convert karein.
- JSON Viewer — Text aur collapsible tree viewer, expand/collapse aur node paths ke saath.
- Markdown Preview — Markdown ko live preview ke saath HTML mein render karein.
Saare ArrayKit tools