مستندات OpenAPI/Swagger را ببینید، اعتبارسنجی و نمونهی cURL بگیرید
سند OpenAPI یا Swagger قرارداد یک API است: چه مسیرهایی دارد، هر کدام چه پارامتر و بدنهای میگیرد و چه پاسخی میدهد. خواندن یک فایل YAML یا JSON چندهزارخطی سخت است و یک خطای کوچک در آن ابزارهای سازندهی کد و مستندات را از کار میاندازد. این نمایشگر سند را میخواند، با اسکیمای رسمی نسخهاش اعتبارسنجی میکند و همهی عملیاتها را با پارامترها، بدنه و پاسخهایشان خوانا نشان میدهد.
Swagger 2.0 و OpenAPI 3.0 و 3.1 پشتیبانی میشوند و ارجاعهای داخلی $ref باز میشوند. سند فقط در مرورگر شما خوانده میشود و ارجاعهای بیرونی دریافت نمیشوند.
سند را بدهید
متن JSON یا YAML را در «سند OpenAPI یا Swagger» بچسبانید یا فایل را رها کنید؛ حجم تا ۵ مگابایت.
اعتبار را بررسی کنید
نسخه خودکار تشخیص داده میشود و سند با اسکیمای رسمی همان نسخه سنجیده میشود؛ هر خطا با مسیر دقیق و توضیح فارسی نمایش داده میشود.
عملیاتها را مرور کنید
عملیاتها با روش و مسیر فهرست میشوند؛ با «جستوجو در عملیات» بر اساس مسیر، روش، عنوان یا برچسب فیلتر کنید و هر کدام را باز کنید تا پارامترها و پاسخها را ببینید.
سرور را انتخاب کنید
اگر سند چند سرور تعریف کرده، یکی را انتخاب کنید تا نشانی کامل هر عملیات بر پایهی آن نمایش داده شود.
یک سند کوچک و معتبر
یک عملیات GET با پارامتر مسیر؛ سند با اسکیمای OpenAPI 3.1 معتبر است.
openapi: 3.1.0
info:
title: Shop API
version: "1.0"
paths:
/orders/{id}:
get:
summary: Get one order
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
"200":
description: OK
نتیجه: OpenAPI 3.1 · معتبر · GET /orders/{id}
سندی که version ندارد
بخش info در OpenAPI همیشه به version نیاز دارد.
openapi: 3.0.3
info:
title: X
paths: {}
نتیجه: /info/version: ویژگی الزامی «version» وجود ندارد.
فایل OpenAPI را اینجا رها کنید یا انتخاب کنید
انواع مجاز: .json، .yaml، .yml · حداکثر حجم هر فایل: ۵٫۰ مگابایت
حداکثر حجم ۵ مگابایت؛ پردازش کاملاً در مرورگر شما انجام میشود. ارجاعهای بیرونی ($ref) هرگز دریافت نمیشوند.