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

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

‫Apigee Edge مکانی برای ذخیره «مشخصات OpenAPI» دراختیارتان قرار می‌دهد. «مشخصات OpenAPI» خود را همان‌طور که در بخش‌های زیر توضیح داده شده است مدیریت کنید.

برای کسب اطلاعات بیشتر درباره «مشخصات OpenAPI»، به مشخصات OpenAPI چیست؟ مراجعه کنید.

کاوش فهرست مشخصات

برای دسترسی به فهرست مشخصات:

  1. به سیستم apigee.com/edge وارد شوید.
  2. سازمانی را انتخاب کنید.
  3. در منو پیمایش کناری، توسعه > مشخصات را انتخاب کنید.

فهرست فعلی مشخصات و پوشه‌ها نمایش داده می‌شود.

فهرست مشخصات

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

ایجاد «مشخصات OpenAPI» جدید

برای ایجاد «مشخصات OpenAPI» جدید:

  1. در نوار پیمایش کناری، روی توسعه > مشخصات کلیک کنید.
  2. روی + مشخصات کلیک کنید.
  3. روی مشخصات جدید در منوِ کرکره‌ای کلیک کنید. ویرایشگر مشخصات باز می‌شود.
  4. مشخصات نمونه را با جزئیات «مشخصات OpenAPI» خودتان جایگزین کنید.
    ایجاد مشخصات بااستفاده از ویرایشگر مشخصات را ببینید.
  5. برای ذخیره کردن مشخصات، روی ذخیره کلیک کنید.
  6. وقتی از شما خواسته شد، نامی برای مشخصات وارد کنید.
  7. روی ذخیره کلیک کنید.

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

برای وارد کردن «مشخصات OpenAPI»:

  1. در نوار پیمایش کناری، روی توسعه > مشخصات کلیک کنید.
  2. روی + مشخصات کلیک کنید.
  3. روی یکی از گزینه‌های زیر از منوِ کرکره‌ای کلیک کنید:
    • برای وارد کردن مشخصات از نشانی وب، وارد کردن نشانی وب را انتخاب کنید. وقتی از شما خواسته شد، نام و نشانی وب را مشخص کنید.
    • برای مرور کردن مشخصات در دایرکتوری محلی، وارد کردن فایل را انتخاب کنید.
      مشخصات به فهرست اضافه شد.
  4. روی نام مشخصات کلیک کنید تا آن را در ویرایشگر مشخصات مشاهده و ویرایش کنید.
    به ایجاد مشخصات بااستفاده از ویرایشگر مشخصات مراجعه کنید.

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

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

  1. در نوار پیمایش کناری، روی توسعه > مشخصات کلیک کنید.
  2. روی ردیف مرتبط با مشخصات در فهرست مشخصات کلیک کنید.
  3. مشخصات را در ویرایشگر مشخصات ویرایش کنید.
    ایجاد مشخصات بااستفاده از ویرایشگر مشخصات را ببینید.

ایجاد یک پراکسی API از مشخصات در فهرست مشخصات

با Apigee Edge، می‌توانید پراکسی‌های میانای برنامه‌سازی کاربردی خود را از «مشخصات OpenAPI» که طراحی و در ویرایشگر مشخصات ذخیره می‌کنید ایجاد کنید. تنها با چند کلیک، یک پراکسی API در Apigee Edge با مسیرها، پارامترها، جریان‌های شرطی، و نقاط پایانی هدف که به‌طور خودکار تولید شده‌اند خواهید داشت. سپس می‌توانید ویژگی‌هایی مثل امنیت OAuth، محدودیت نرخ، و حافظه نهان را اضافه کنید.

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

برای ایجاد یک پراکسی API از یک «مشخصات OpenAPI» در فهرست مشخصات:

  1. در منو پیمایش کناری، توسعه > مشخصات را انتخاب کنید.
  2. درصورت نیاز، به پوشه‌ای که حاوی «مشخصات OpenAPI» است پیمایش کنید.
  3. مکان‌نما را روی «مشخصات OpenAPI» که می‌خواهید برای آن کارگزار نیابتی API ایجاد کنید قرار دهید تا منو کنش‌ها نمایش داده شود.
  4. روی تولید پراکسی کلیک کنید. جادوگر «ایجاد پراکسی» باز می‌شود و صفحه جزئیات «پراکسی» بااستفاده از مقادیر «مشخصات OpenAPI» ازپیش تکمیل می‌شود، همان‌طور که در شکل زیر نشان داده شده است.
    ساختن جادوگر پراکسی
  5. روی بعدی کلیک کنید.
  6. صفحه‌های باقی‌مانده در جادوگر «ایجاد پراکسی» را همان‌طور که در ایجاد پراکسی API از «مشخصات OpenAPI» توضیح داده شده است گام‌به‌گام طی کنید. (از مرحله ۸ شروع کنید.)

تغییر دادن نام مشخصات

برای تغییر نام مشخصات:

  1. در منو پیمایش کناری، توسعه > مشخصات را انتخاب کنید.
  2. درصورت نیاز، به پوشه‌ای که حاوی مشخصات است پیمایش کنید.
  3. مکان‌نما را روی مشخصاتی که می‌خواهید تغییر نام دهید قرار دهید تا منو کنش‌ها نمایش داده شود.
  4. روی تغییر نام مشخصات کلیک کنید.
  5. نام مشخصات را ویرایش کنید.
  6. برای ذخیره کردن ویرایش‌ها روی تغییر نام کلیک کنید یا برای لغو کردن روی لغو کلیک کنید.

انتقال مشخصات به پوشه

می‌توانید مشخصات خود را در پوشه‌ها سازمان‌دهی کنید تا مدیریت و امنیت تسهیل شود. برای انتقال مشخصات به پوشه، سازمان‌دهی مشخصات بااستفاده از پوشه‌ها را ببینید.

حذف مشخصات

وقتی مشخصه‌ای دیگر لازم نیست یا نامعتبر می‌شود، می‌توانید آن را از فروشگاه فایل حذف کنید.

برای حذف مشخصات:

  1. در منو پیمایش کناری، توسعه > مشخصات را انتخاب کنید.
  2. مکان‌نما را روی مشخصاتی که می‌خواهید حذف کنید قرار دهید تا منو کنش‌ها نمایش داده شود.
  3. روی حذف نماد کلیک کنید.
  4. برای تأیید عملیات حذف در پیام‌واره، روی حذف کلیک کنید.
  5. داده‌های جلسه مرتبطی را که دیگر نیاز نیست حذف کنید.