ایجاد مشخصات بااستفاده از ویرایشگر مشخصات

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

بااستفاده از ویرایشگر مشخصات، بدون نوشتن هیچ کدی «مشخصات OpenAPI» ایجاد و اعتبارسنجی کنید.

دسترسی به ویرایشگر مشخصات

«مشخصات OpenAPI» را در ویرایشگر مشخصات باز کنید، همان‌طور که در بخش‌های زیر توضیح داده شده است:

• ایجاد «مشخصات OpenAPI» جدید
• وارد کردن «مشخصات OpenAPI»
• ویرایش «مشخصات OpenAPI» موجود

شکل زیر مشخصات Petstore API را نشان می‌دهد که در ویرایشگر مشخصات باز است:

همان‌طور که در شکل قبلی برجسته شده است، ویرایشگر مشخصات به شما امکان می‌دهد:

• «مشخصات OpenAPI» خود را برای مدل‌سازی «میانای برنامه‌سازی کاربردی» بااستفاده از قالب JSON یا YAML در قاب سمت راست ایجاد کنید.
• اسناد API تولیدشده به‌صورت خودکار را در قاب سمت چپ مشاهده کنید.
• هم‌زمان با تایپ کردن، مشخصات خود را دربرابر استاندارد «مشخصات OpenAPI» اعتبارسنجی کنید.
• «مشخصات» OpenAPI خود را ذخیره کنید یا مشخصات را ببندید و ویرایش‌هایتان را لغو کنید.

درخصوص JSON و YAML کمکم کن

JSON (نشان‌گذاری شیء جاوا اسکریپت) قالبی سبک برای تبادل داده است که برای نمایش ساختارهای داده ساده و آرایه‌های انجمنی استفاده می‌شود. برای کسب اطلاعات بیشتر، به https://www.json.org مراجعه کنید.

YAML (YAML Ain't Markup Language) یک استاندارد سریال‌سازی/نمایش داده است که نحوی را ارائه می‌دهد که می‌تواند به ساختارهای داده‌ای مانند فهرست‌ها، آرایه‌های انجمنی، و اسکالرها نگاشت شود. برای کسب اطلاعات بیشتر، https://yaml.org را ببینید.

هم JSON و هم YAML برای ماشین قابل‌خواندن هستند، اما برای انسان‌ها نیز خواندن و درک آن‌ها آسان است. شکل زیر دو گزیده کوتاه از «مشخصات OpenAPI» یکسان را که بااستفاده از JSON و YAML نوشته شده است مقایسه می‌کند:

اعتبارسنجی مشخصات

ویرایشگر مشخصات «مشخصات OpenAPI» شما را درمقایسه با استاندارد «مشخصات OpenAPI» اعتبارسنجی می‌کند. هنگام تایپ کردن، اگر خطاهایی در «مشخصات OpenAPI» شما وجود داشته باشد، ویرایشگر مشخصات گفتگوی «خطا» را در بالای قاب سمت چپ نمایش می‌دهد و اطلاعات بیشتری درباره خطاها و شماره خط‌های مرتبط با آن‌ها ارائه می‌دهد تا بتوانید به‌راحتی آن‌ها را اصلاح کنید.

ذخیره مشخصات

برای ذخیره کردن «مشخصات OpenAPI»، در نوار پیمایش بالا روی ذخیره کلیک کنید.

اگر این اولین‌بار است که مشخصات را ذخیره می‌کنید، از شما خواسته می‌شود نام فایل را وارد کنید. اگر نام فایلی مشخص نکنید، به‌طور پیش‌فرض «بدون عنوان» خواهد بود. بعداً می‌توانید آن را تغییر نام دهید.

بستن مشخصات

برای بستن «مشخصات OpenAPI» بدون ذخیره کردن ویرایش‌ها، روی لغو در نوار پیمایش بالا کلیک کنید. به فهرست مشخصات برگردانده می‌شوید.