شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
مشخصات OpenAPI را بدون نوشتن هیچ کدی با استفاده از ویرایشگر مشخصات ایجاد و اعتبارسنجی کنید.
دسترسی به ویرایشگر مشخصات
همانطور که در بخشهای زیر توضیح داده شده است، یک OpenAPI Specification را در ویرایشگر مشخصات باز کنید:
شکل زیر مشخصات مربوط به Petstore API را که در ویرایشگر مشخصات باز است نشان میدهد:
همانطور که در شکل قبلی مشخص شده است، ویرایشگر مشخصات شما را قادر میسازد تا:
- مشخصات OpenAPI خود را برای مدلسازی API با استفاده از فرمت 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، روی ذخیره در نوار پیمایش بالا کلیک کنید.
اگر این اولین باری است که مشخصات را ذخیره میکنید، از شما خواسته میشود نام فایل را وارد کنید. اگر نام فایل را مشخص نکنید، به طور پیشفرض روی «بدون عنوان» (Untitled) تنظیم میشود. میتوانید بعداً آن را تغییر نام دهید .
بستن مشخصات
برای بستن مشخصات OpenAPI بدون ذخیره ویرایشهایتان، روی لغو در نوار پیمایش بالا کلیک کنید. به لیست مشخصات بازگردانده میشوید.