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

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

Apigee Edge مکانی را برای ذخیره مشخصات OpenAPI شما فراهم می‌کند. مشخصات OpenAPI خود را، همانطور که در بخش‌های بعدی توضیح داده شده است، مدیریت کنید.

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

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

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

  1. وارد apigee.com/edge شوید.
  2. یک سازمان را انتخاب کنید.
  3. در منوی ناوبری کناری، گزینه‌ی توسعه > مشخصات (Develop > Specs) را انتخاب کنید.

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

لیست مشخصات

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

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

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

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

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

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

  1. در نوار ناوبری کناری، روی Develop > Specs کلیک کنید.
  2. روی + مشخصات کلیک کنید.
  3. از منوی کشویی، روی یکی از گزینه‌های زیر کلیک کنید:
    • برای وارد کردن مشخصات از یک URL، از گزینه Import URL استفاده کنید . در صورت درخواست، نام و URL را مشخص کنید.
    • فایل را وارد کنید تا مشخصات را در دایرکتوری محلی خود جستجو کنید.
      مشخصات به لیست اضافه شد.
  4. برای مشاهده و ویرایش مشخصات در ویرایشگر مشخصات، روی نام مشخصات کلیک کنید.
    به بخش «ایجاد مشخصات با استفاده از ویرایشگر مشخصات» مراجعه کنید.

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

برای باز کردن یک OpenAPI Specification موجود:

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

ایجاد یک پروکسی API از مشخصات موجود در لیست مشخصات

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

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

برای ایجاد یک پروکسی API از مشخصات OpenAPI در لیست مشخصات:

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

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

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

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

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

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

حذف مشخصات

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

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

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