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

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

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

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

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

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

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

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

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

با JSON و YAML به من کمک کنید

JSON (JavaScript Object Notation) یک فرمت تبادل داده سبک وزن است که برای نمایش ساختارهای داده ساده و آرایه های انجمنی استفاده می شود. برای کسب اطلاعات بیشتر، به https://www.json.org مراجعه کنید.

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

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

تایید یک مشخصات

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

یک مشخصات را ذخیره کنید

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

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

یک مشخصات را ببندید

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