شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
Apigee Edge مکانی برای ذخیره مشخصات OpenAPI در اختیار شما قرار می دهد. همانطور که در بخش های زیر توضیح داده شده است، مشخصات OpenAPI خود را مدیریت کنید.
برای اطلاعات بیشتر در مورد مشخصات OpenAPI، مشخصات OpenAPI چیست؟
لیست مشخصات را کاوش کنید
برای دسترسی به لیست مشخصات:
- به apigee.com/edge وارد شوید.
- یک سازمان را انتخاب کنید.
- Develop > Specs را در منوی ناوبری کناری انتخاب کنید.
لیست فعلی مشخصات و پوشه ها نمایش داده می شود.
همانطور که در شکل قبل مشخص شده است، از لیست مشخصات می توانید:
- ایجاد و وارد کردن مشخصات
- با استفاده از یک جادوگر چند مرحله ای، یک پروکسی API از یک مشخصات ایجاد کنید
- مشخصات خود را با استفاده از پوشه ها سازماندهی کنید و در آن پوشه ها پیمایش کنید ( به سازماندهی محتوا با استفاده از پوشه ها مراجعه کنید)
- یک مشخصات را ویرایش کنید یا با کلیک کردن روی یک ردیف، یک پوشه را باز کنید
- تغییر نام یا حذف مشخصات
- لیست مشخصات و پوشه ها را جستجو کنید
یک مشخصات OpenAPI جدید ایجاد کنید
برای ایجاد مشخصات OpenAPI جدید:
- روی Develop > Specs در نوار ناوبری کناری کلیک کنید.
- روی + Spec کلیک کنید.
- در منوی کشویی روی New Spec کلیک کنید. ویرایشگر مشخصات باز می شود.
- مشخصات نمونه را با جزئیات مشخصات OpenAPI خود جایگزین کنید.
به ایجاد مشخصات با استفاده از ویرایشگر مشخصات مراجعه کنید. - برای ذخیره مشخصات روی Save کلیک کنید.
- وقتی از شما خواسته شد نامی برای مشخصات وارد کنید.
- روی ذخیره کلیک کنید.
یک مشخصات OpenAPI را وارد کنید
برای وارد کردن مشخصات OpenAPI:
- روی Develop > Specs در نوار ناوبری کناری کلیک کنید.
- روی + Spec کلیک کنید.
- یکی از گزینه های زیر را از منوی کشویی کلیک کنید:
- URL را وارد کنید تا مشخصات را از URL وارد کنید. وقتی از شما خواسته شد نام و URL را مشخص کنید.
- فایل را برای مرور فهرست محلی خود برای مشخصات وارد کنید .
مشخصات به لیست اضافه می شود.
- برای مشاهده و ویرایش آن در ویرایشگر مشخصات، روی نام مشخصات کلیک کنید.
به ایجاد مشخصات با استفاده از ویرایشگر مشخصات مراجعه کنید.
یک مشخصات OpenAPI موجود را ویرایش کنید
برای باز کردن مشخصات OpenAPI موجود:
- روی Develop > Specs در نوار ناوبری کناری کلیک کنید.
- روی ردیف مرتبط با مشخصات در لیست مشخصات کلیک کنید.
- مشخصات را در ویرایشگر مشخصات ویرایش کنید.
به ایجاد مشخصات با استفاده از ویرایشگر مشخصات مراجعه کنید.
یک پروکسی API از مشخصات موجود در لیست مشخصات ایجاد کنید
با Apigee Edge، میتوانید پروکسیهای API خود را از مشخصات OpenAPI که طراحی میکنید و در ویرایشگر مشخصات ذخیره میکنید ایجاد کنید. تنها با چند کلیک، یک پراکسی API در Apigee Edge خواهید داشت که مسیرها، پارامترها، جریانهای شرطی و نقاط پایانی هدف بهطور خودکار تولید میشوند. سپس، میتوانید ویژگیهایی مانند امنیت OAuth، محدود کردن نرخ و حافظه پنهان را اضافه کنید.
پس از ایجاد یک پراکسی API از مشخصات OpenAPI، اگر مشخصات اصلاح شود، باید به صورت دستی پروکسی API را تغییر دهید تا تغییرات اجرا شده را منعکس کند. ببینید اگر مشخصاتی را تغییر دهم چه اتفاقی میافتد؟ .
برای ایجاد یک پراکسی API از یک OpenAPI Specification در لیست مشخصات:
- Develop > Specs را در منوی ناوبری کناری انتخاب کنید.
- در صورت نیاز به پوشه ای که حاوی مشخصات OpenAPI است بروید.
- مکان نما خود را روی مشخصات OpenAPI قرار دهید که میخواهید برای آن یک پراکسی API ایجاد کنید تا منوی عملکردها را نمایش دهد.
- کلیک کنید . همانطور که در شکل زیر نشان داده شده است، جادوگر Create Proxy باز می شود و صفحه جزئیات پروکسی با استفاده از مقادیر از OpenAPI Specification از قبل پر می شود.
- روی Next کلیک کنید.
- همانطور که در ایجاد یک پروکسی API از مشخصات OpenAPI توضیح داده شده است، از صفحات باقیمانده در جادوگر ایجاد پروکسی عبور کنید. (از مرحله 8 شروع کنید.)
تغییر نام مشخصات
برای تغییر نام مشخصات:
- Develop > Specs را در منوی ناوبری کناری انتخاب کنید.
- در صورت نیاز به پوشه ای که حاوی مشخصات است بروید.
- مکان نما را روی مشخصاتی که می خواهید تغییر نام دهید قرار دهید تا منوی اقدامات نمایش داده شود.
- کلیک کنید .
- نام مشخصات را ویرایش کنید.
- برای ذخیره ویرایشها روی تغییر نام یا برای لغو روی لغو کلیک کنید.
یک مشخصات را به یک پوشه منتقل کنید
برای تسهیل مدیریت و امنیت می توانید مشخصات خود را در پوشه ها سازماندهی کنید. برای انتقال مشخصات به یک پوشه، به سازماندهی مشخصات با استفاده از پوشه ها مراجعه کنید.
یک مشخصات را حذف کنید
هنگامی که مشخصاتی دیگر مورد نیاز نیست یا نامعتبر می شود، می توانید مشخصات را از فروشگاه فایل حذف کنید.
برای حذف مشخصات:
- Develop > Specs را در منوی ناوبری کناری انتخاب کنید.
- مکان نما را روی مشخصاتی که می خواهید حذف کنید قرار دهید تا منوی اقدامات نمایش داده شود.
- کلیک کنید .
- روی Delete کلیک کنید تا عملیات حذف در اعلان تایید شود.
- مصنوعات مرتبطی را که دیگر مورد نیاز نیستند حذف کنید.