15.05.27.00 - یادداشت‌های انتشار پورتال خدمات توسعه‌دهنده Apigee

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

در روز سه‌شنبه، ۲ ژوئن ۲۰۱۵، نسخه ابری جدیدی از پورتال خدمات توسعه‌دهندگان Apigee منتشر کردیم.

اگر سوالی دارید، با پشتیبانی Apigee Edge تماس بگیرید.

برای مشاهده‌ی فهرستی از تمام یادداشت‌های انتشار Apigee Edge، به یادداشت‌های انتشار Apigee مراجعه کنید.

ویژگی‌های جدید

دسترسی عمومی به SmartDocs

SmartDocs در حال گذر از مرحله بتا به نسخه عمومی است. به‌روزرسانی‌ها و ویژگی‌های جدید عبارتند از:

  • پشتیبانی از Swagger 2.0، شامل وارد کردن از طریق فایل یا URL، شامل پشتیبانی از اشیاء امنیتی با نام سفارشی.
  • بهبود طراحی بصری در قالب‌هایی که SmartDocs را تولید می‌کنند.
  • بهبودهای قابلیت استفاده و گردش کار در پورتال توسعه‌دهندگان، که از طریق منوی محتوا > اسناد هوشمند در دروپال قابل دسترسی است.
  • آنچه که پیش از این به عنوان احراز هویت «توکن سفارشی» شناخته می‌شد، اکنون «کلید API» نامیده می‌شود.
  • اشیاء «امنیتی» احراز هویت که در سطح ویرایش تعریف شده‌اند.
  • پیکربندی احراز هویت کلاینت در سطح الگو. نسخه‌های جدید دیگر هیچ یک از اعتبارنامه‌های کلاینت SmartDocs از پیش پیکربندی‌شده را بازنشانی نمی‌کنند.

برای توضیحات بیشتر در مورد ویژگی‌ها، به این پست وبلاگ مراجعه کنید.

برای مستندات SmartDocs، به بخش «استفاده از SmartDocs برای مستندسازی APIها» مراجعه کنید.

فرآیند ارتقاء SmartDocs

اگر در طول دوره بتا از SmartDocs استفاده می‌کردید، برای دسترسی به ویژگی‌ها و قابلیت‌های جدید در نسخه عمومی، باید SmartDocs را در پورتال توسعه‌دهندگان خود ارتقا دهید.

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

به خاطر داشته باشید که اگرچه می‌توانید SmartDocs را درون پورتال توسعه‌دهندگان خود رندر و منتشر کنید، SmartDocs از مدل API تولید می‌شوند که درون سرویس‌های مدیریت API Edge شرکت Apigee قرار دارد. هر تغییری که در یک مدل API در Edge ایجاد کنید، در تمام محیط‌های Pantheon شما یکسان خواهد بود (مشابه نحوه حضور توسعه‌دهندگان در محیط‌های Pantheon).

برای ارتقا از نسخه بتای SmartDocs به نسخه عمومی

  1. نسخه ۱۵.۰۵.۲۷ را در محیط‌های توسعه یا آزمایش خود در Pantheon به‌روزرسانی و آزمایش کنید.
  2. یک مدل جدید ایجاد کنید تا جایگزین هر مدل API موجودی شود که قبلاً استفاده می‌کردید.
    • اگر اسناد Swagger یا WADL را وارد کرده‌اید، دوباره آنها را به یک نسخه جدید وارد کنید.
    • اگر مدل API خود را از طریق ماژول SmartDocs نگهداری می‌کردید، آن را به صورت SmartDocs JSON خروجی بگیرید و با استفاده از پیوست فایل، به مدل جدید خود وارد کنید.
  3. ویژگی‌های امنیتی نسخهٔ اصلاح‌شدهٔ مدل خود را تنظیم کنید. در صفحهٔ «محتوا > اسناد هوشمند > مدل» ، «تنظیمات امنیتی» را انتخاب کنید.
  4. با کلیک روی تنظیمات در ستون عملیات، هرگونه احراز هویت از پیش پیکربندی شده را در صفحه تنظیمات مدل ( محتوا > اسناد هوشمند ) بررسی کنید.
  5. هرگونه قالب سفارشی را برای استفاده از نسخه ۶ از دارایی‌های CSS و JS به‌روزرسانی کنید و تغییراتی ایجاد کنید تا نام‌های جدید اشیاء، مانند authSchemes و apiSchema، را منعکس کند. برای اطلاعات بیشتر در مورد به‌روزرسانی قالب‌های SmartDocs، به بخش «استفاده از SmartDocs برای مستندسازی APIها» مراجعه کنید.
  6. نسخه اصلاح‌شده مدل خود را دوباره رندر و منتشر کنید.
  7. پس از تأیید مستندات جدید، پورتال تولید خود را به نسخه 15.05.27 به‌روزرسانی کنید.

اگر شما مشتری سازمانی Edge هستید و در مورد فرآیند ارتقا سؤال یا نگرانی دارید، لطفاً به آدرس‌های marsh@apigee.com و cnovak@apigee.com ایمیل بزنید. در غیر این صورت، لطفاً برای بهترین پاسخ از انجمن Apigee استفاده کنید.

اشکالات برطرف شد

اشکالات زیر در این نسخه برطرف شده‌اند.

شناسه مسئله توضیحات
DEVSOL-487 قالب روز در بخش کسب درآمد باید توسط مدیران قابل تنظیم باشد.
قالب تاریخ اکنون در بخش «کسب درآمد» و در بخش «تنظیمات کسب درآمد» برای قالب‌های تاریخ اروپایی و آمریکایی قابل تنظیم است.
DEVSOL-603 صفحه طرح تعارض قالب‌بندی ضعیفی دارد
هنگام خرید طرحی که با طرح موجود همپوشانی دارد، صفحه نمایش داده شده اکنون به خوبی برای کاربر قالب‌بندی شده است.
دوسول-۶۴۲ پیکربندی‌های سطح کلاینت را از تنظیمات امنیتی به تنظیمات قالب منتقل کنید
DEVSOL-709 SmartDocs: پارامتر الگوی URL پس از ارسال درخواست با مقدار خالی قابل ویرایش نیست
مشکلی که باعث می‌شد پارامترهای الگو پس از ارسال درخواست از SmartDocs و حذف پارامتر الگو در مستندات متد، غیرقابل ویرایش شوند، برطرف شد.
DEVSOL-1013 آدرس‌های ایمیل کاربران پورتال توسعه‌دهندگان را قابل ویرایش کنید
فیلد آدرس ایمیل در صفحه ویرایش پروفایل دیگر غیرفعال نخواهد شد و توسعه‌دهندگان می‌توانند آدرس‌های ایمیل خود را تغییر دهند.
DEVSOL-1273 «DevConnect Mint» دو بار در فهرست ماژول‌ها نمایش داده می‌شود
در قسمت ماژول‌ها، عبارت «Dev Connect Mint» دو بار نمایش داده می‌شد. این مشکل اکنون برطرف شده است.
DEVSOL-1313 پشتیبانی از وارد کردن فایل JSON/YAML یا URL برای Swagger و WADL
اکنون می‌توان فایل‌های WADL را از طریق URL وارد کرد و فایل‌های Swagger را آپلود نمود.
DEVSOL-1339 تغییر مکان منوی مدیریت SmartDocs
SmartDocs اکنون در زیر منوی محتوا قرار دارد و تنظیمات smartdocs در زیر منوی تنظیمات مدیریت قرار دارند.
DEVSOL-1340 هنگام رفتن به GA، بتا را حذف کنید
SmartDocs اکنون در زیر منوی محتوا قرار دارد و تنظیمات smartdocs در زیر منوی تنظیمات مدیریت قرار دارند.
DEVSOL-1390 کتابخانه PHP SDK Edge به‌روزرسانی شده است تا مشکل فراخوانی __toString() برطرف شود.
کتابخانه PHP SDK Edge به‌روزرسانی شده است تا مشکل فراخوانی __toString() روی شیء DeveloperRatePlan که این خطا را ایجاد می‌کند، برطرف شود: {quote} خطای مهلک: فراخوانی تابع عضو format() روی یک غیر شیء در /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php در خط ۲۲۱ {quote} این یک اشکال است که فقط مشتریان Monetization را با کد سفارشی که متد toString() را فراخوانی می‌کند، تحت تأثیر قرار می‌دهد.
DEVSOL-1398 مدل SmartDocs Petstore هنگام نصب بدون اعلان کاربر وارد شد
SmartDocs اکنون به جای مدل آب و هوا، مثال petstore swagger را در حین نصب سایت (http://petstore.swagger.io/v2/swagger.json) وارد می‌کند تا مثال جامع‌تری از استفاده از SmartDocs داشته باشد.
DEVSOL-1407 وقتی تعداد توسعه‌دهندگان زیاد باشد، کرون از کار می‌افتد
هنگام اجرای کرون دروپال، تعداد زیادی از توسعه‌دهندگان باعث ایجاد مشکل تایم اوت شدند. وقتی یک سازمان بیش از ۲۰۰ کاربر دارد، اکنون از یک فرآیند دسته‌ای استفاده می‌شود.
DEVSOL-1470 ایجاد لینک منو "APIها" و نمای مربوطه
SmartDocs پورتال توسعه‌دهندگان اکنون به‌طور پیش‌فرض با پیوندی به مستندات رندر شده SmartDocs در منوی اصلی با نام "APIs" ارائه می‌شود که به هر مدلی با متدهای منتشر شده پیوند می‌دهد.

مشکلات شناخته شده

این نسخه شامل مشکلات شناخته شده زیر است:

شناسه مسئله توضیحات
DEVSOL-1558
مثال Petstore صفحات متد SmartDocs در نصب جدید به درستی رندر نمی‌شوند
صفحات متد Petstore نمونه در SmartDocs در نصب جدید به درستی نمایش داده نمی‌شوند. برای رفع این مشکل:
  1. در منوی دروپال، گزینه محتوا > اسناد هوشمند (Content > SmartDocs) را انتخاب کنید.
  2. مدل «مثال فروشگاه حیوانات خانگی» را انتخاب کنید.
  3. در قسمت Update Options، گزینه Render and publish nodes را انتخاب کنید.
  4. برای انتخاب همه گره‌ها، روی کادر انتخاب / عدم انتخاب همه کلیک کنید.
  5. روی به‌روزرسانی کلیک کنید.

گره‌ها اکنون باید به درستی رندر شوند.