چرخه حیات توسعه میانای برنامه‌سازی کاربردی

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

هر سازمانی چرخه عمر توسعه نرم‌افزار (SDLC) منحصربه‌فردی دارد. اغلب لازم است استقرار پراکسی API را با همان فرایندهایی که امروز برای توسعه، آزمایش، و استقرار برنامه‌های دیگر استفاده می‌کنید همگام‌سازی و هماهنگ کنید.

«خدمات API» ابزارها و RESTful APIs را ارائه می‌دهد که به شما امکان می‌دهد استقرار و مدیریت پراکسی API را در SDLC سازمانتان ادغام کنید. یکی از کاربردهای رایج «میانای برنامه‌سازی کاربردی RESTful» نوشتن دستورگان یا کدی است که کارگزاران میانای برنامه‌سازی کاربردی را به‌صورت برنامه‌ریزی‌شده مستقر می‌کند یا کارگزاران میانای برنامه‌سازی کاربردی را به‌عنوان بخشی از فرایند خودکارسازی بزرگ‌تری که برنامه‌های دیگر را نیز مستقر یا منتقل می‌کند، از محیطی به محیط دیگر منتقل می‌کند. «خدمات API» هیچ فرضی درباره «چرخه حیات توسعه نرم‌افزار» شما (یا هر کس دیگری) ندارد. بلکه، این API توابع اتمی را آشکار می‌کند که تیم توسعه شما می‌تواند آن‌ها را هماهنگ کند تا چرخه حیات توسعه API شما را خودکارسازی و بهینه‌سازی کند.

میاناهای برنامه‌سازی کاربردی «سرویس‌های API» در «مرجع API» مستند شده‌اند. مرجع میانای برنامه‌سازی کاربردی آغاز به کار را ببینید.

برای آشنایی با محیط‌های API و چرخه حیات توسعه API، این ویدیو را تماشا کنید.

محیط

هر سازمان در Apigee Edge حداقل دو محیط استقرار دارد که برای پراکسی‌های API دردسترس هستند: «test» و «prod». تفاوت بین این دو محیط اختیاری است — هر محیط به‌سادگی با مجموعه متفاوتی از نشانی‌های شبکه (نشانی‌های وب) شناسایی می‌شود. هدف این است که دامنه‌ای دراختیارتان قرار دهیم که بتوانید در آن پیش‌از اینکه میانای برنامه‌سازی کاربردی دراختیار توسعه‌دهندگان خارجی قرار گیرد، کارگزاران میانای برنامه‌سازی کاربردی را بسازید و درستی‌سنجی کنید.

می‌توانید از این محیط‌ها برای همگام‌سازی کردن فرایندهای توسعه پراکسی میانای برنامه‌سازی کاربردی با SDLC خود استفاده کنید. هر محیط با نشانی شبکه تعریف می‌شود و به شما امکان می‌دهد ترافیک را بین کارگزاران پراکسی API که روی آن‌ها کار می‌کنید و کارگزارانی که در زمان اجرا توسط برنامه‌ها به آن‌ها دسترسی پیدا می‌شود تفکیک کنید. نشانی‌های شبکه دردسترس برای هر محیط در مجموعه VirtualHosts دردسترس در آن محیط تعریف شده است.

در ورودی، TLS/SSL سرور به‌طور خودکار برای هر محیط فعال می‌شود. دو «میزبان مجازی» در هر محیط ازپیش تعریف شده است: default و secure. «پیش‌فرض» نشانی HTTP را تعریف می‌کند، درحالی‌که «ایمن» نشانی HTTP/S را با TLS/SSL سمت سرور ازپیش پیکربندی‌شده تعریف می‌کند. در پیکربندی پراکسی میانای برنامه‌سازی کاربردی، مشخص می‌کنید که ProxyEndpoint باید در کدام VirtualHosts گوش کند. هنگام ارتقا دادن به محیط تولید، معمولاً با برداشتن default VirtualHost از پیکربندی پراکسی API، پروتکل HTTP را غیرفعال می‌کنید.

برای مثال، ProxyEndpoint زیر به HTTP و HTTPS گوش می‌دهد.

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>default</VirtualHost>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

با حذف کردن default VirtualHost از پیکربندی ProxyEndpoint، کارگزاری API ایجاد می‌کنید که فقط روی HTTPS و نه روی HTTP گوش می‌دهد.

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

با انتخاب محیط‌ها در منو اصلی رابط کاربری مدیریت، می‌توانید ببینید کدام «میزبان‌های مجازی» در محیط دردسترس هستند.

محیط‌ها همچنین داده‌ها و منابع را تفکیک می‌کنند. برای مثال، می‌توانید در محیط‌های آزمایش و تولید، حافظه‌های نهان مختلفی راه‌اندازی کنید که فقط ازطریق پراکسی‌های میانای برنامه‌سازی کاربردی که در آن محیط اجرا می‌شوند قابل‌دسترسی باشند. علاوه‌براین، کلیدهای API که در محیط آزمایش صادر می‌شوند در محیط تولید معتبر نیستند و بالعکس.

استقرار پراکسی‌های API در محیط‌ها

وقتی کارگزار نیابتی API ایجاد می‌کنید، باید تصمیم بگیرید در کدام محیط کار خواهید کرد. می‌توانید انتخاب کنید که یک پراکسی API جدید در محیط تولید ایجاد کنید، اما این کار توصیه نمی‌شود زیرا ممکن است API را قبل‌از آماده شدن دراختیار توسعه‌دهندگان قرار دهید. به‌طورکلی، با ایجاد یک پراکسی API در test شروع کنید که پس‌از آزمایش، آن را به prod ارتقا می‌دهید.

برای اطلاعات بیشتر، به درک استقرار مراجعه کنید.

توسعه تکرارشونده در آزمایش

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

ارتقا به تولید

وقتی یک پراکسی API به‌طور کامل پیاده‌سازی و آزمایش شد، آماده است تا به «تولید» ارتقا یابد. از نسخه مرور میانای برنامه‌سازی کاربردی در آزمایش برای بازنویسی نسخه مرور میانای برنامه‌سازی کاربردی استقراریافته در تولید استفاده خواهد شد.

«خدمات میانای برنامه‌سازی کاربردی» قابلیت‌هایی را برای تضمین استقرار یکپارچه پراکسی‌های میانای برنامه‌سازی کاربردی ارائه می‌دهد و تأثیر آن بر برنامه‌ها و کاربران نهایی را درطول فرایند استقرار به حداقل می‌رساند.

استقرار دستورگان‌نویسی

واسط کاربر مدیریت Apigee Edge به شما امکان می‌دهد تا کارگزاران میانای برنامه‌سازی کاربردی را مستقیماً از سازنده کارگزار میانای برنامه‌سازی کاربردی در محیط تولید مستقر کنید. بااین‌حال، در بسیاری از شرایط، الزامات امنیت، قابلیت اطمینان، و ثبات حکم می‌کند که تیم‌های توسعه رویه‌های استقرار را برنامه‌نویسی کنند. برای انجام این کار، می‌توانید کد و دستورگان‌هایی بنویسید که «میانای برنامه‌سازی کاربردی RESTful» ارائه‌شده توسط «سرویس‌های API» را فراخوانی کنند.

منابع محیط

برای کنترل بیشتر درطول تبلیغات، توصیه می‌شود که فقط در تست روی پراکسی‌های API تکرار کنید و در پراکسی‌های API که در تولید مستقر شده‌اند، تا حد امکان تغییرات کمی ایجاد کنید.

برای انجام این کار، باید مطمئن شوید که منابع خاص مرتبط با هر محیط به‌گونه‌ای پیکربندی شده‌اند که می‌توانند در پیکربندی پراکسی API ثابت بمانند.

  • نشانی‌های وب هدف: معمول است که کارگزاران نیابتی API درطول آزمایش و تولید نشانی‌های وب زمینه‌ای مختلفی را فراخوانی کنند. می‌توانید از پیکربندی‌های TargetServer برای ایجاد پیکربندی‌های TargetEndpoint مستقل از محیط استفاده کنید. تراز کردن بار در سرورهای زیرینه را ببینید.
  • نقشه‌های حافظه نهان و کلید/مقدار: هر دو منبع ماندگاری براساس محیط محدود می‌شوند. باید مطمئن شوید که از قراردادهای نام‌گذاری استفاده می‌شود تا پراکسی‌های API بتوانند داده‌ها را بدون نیاز به تغییرات پیکربندی درطول تبلیغات ذخیره کنند. به ایجاد و ویرایش حافظه نهان محیط مراجعه کنید.
  • هدف‌های «نوشته راهنمای تماس با سرویس»: نوشته‌های راهنمای تماس با سرویس ممکن است بسته به محیط از هدف‌های مختلفی استفاده کنند، برای مثال، اگر «نوشته راهنمای تماس با سرویس» در محیط آزمایش از سرویس نمایشی استفاده کند. خط‌مشی «نوشته راهنمای خدمات» را ببینید.

برای اینکه پیکربندی‌های پراکسی API مستقل از محیط باشد، می‌توانید از عبارت‌های شرطی نیز استفاده کنید. از عبارت شرطی ساخته‌شده با متغیر environment.name می‌توان برای ارزیابی محیط کنونی قبل‌از اعمال خط‌مشی یا قبل‌از مسیریابی به نشانی وب در پشتیبان استفاده کرد.

برای اطلاعات بیشتر، به درک استقرار مراجعه کنید.