/
/
/
/
Service Bus پس از ایجاد نیاز به تنظیمات اجرایی دارد. در این بخش تنظیمات ایجاد یا ویرایش Service Bus، نحوه تعریف Methodهای GET و POST و نوع خروجی Response بررسی می‌شود.
ایجاد و ویرایش Service Bus
برای انتشار یک Provider به‌صورت API، ابتدا یک Service Bus ایجاد می‌شود. در زمان ایجاد یا ویرایش Service Bus، تنظیمات مربوط به نحوه فراخوانی، نوع درخواست و ساختار پاسخ مشخص می‌شود.
نکته مهم
Service Bus روی یک Provider موجود ایجاد می‌شود و منطق اصلی اجرا همچنان در Provider باقی می‌ماند.
اطلاعات اصلی Service Bus
| فیلد | توضیح |
|---|---|
| نام Service Bus | عنوان قابل تشخیص سرویس منتشرشده |
| Provider | Provider مرتبط با Service Bus |
| Method | نوع درخواست API مانند GET یا POST |
| Response Type | نوع خروجی بازگشتی سرویس |
GET در Service Bus
Method از نوع GET برای سناریوهایی استفاده می‌شود که هدف اصلی دریافت اطلاعات از Provider است.
- پارامترهای مورد نیاز می‌توانند از طریق Query String دریافت شوند.
- نتیجه Provider به‌عنوان Response سرویس بازگردانده می‌شود.
- ساختار ورودی و خروجی باید مطابق Contract سرویس باشد.
POST در Service Bus
Method از نوع POST برای سناریوهایی استفاده می‌شود که نیاز به ارسال اطلاعات در Request و اجرای عملیات توسط Provider وجود دارد.
| Method | کاربرد |
|---|---|
| GET | دریافت اطلاعات از Provider |
| POST | ارسال داده و اجرای عملیات توسط Provider |
نوع Response در Service Bus
نوع Response مشخص می‌کند نتیجه اجرای Service Bus با چه ساختاری به مصرف‌کننده بازگردانده شود.
JSON Response
در حالت JSON، خروجی Provider به‌صورت داده ساختاریافته بازگردانده می‌شود و برای مصرف توسط برنامه‌ها و سرویس‌های دیگر مناسب است.
text/plain Response
در برخی سناریوها خروجی سرویس به‌صورت متن ساده بازگردانده می‌شود. این حالت برای زمانی مناسب است که Consumer به دریافت مقدار متنی نیاز دارد.
Response Type: JSON or text/plain
نکات طراحی Service Bus
- Method مناسب بر اساس نوع عملیات انتخاب شود.
- Response متناسب با نیاز مصرف‌کننده تعریف شود.
- Contract ورودی و خروجی قبل از انتشار بررسی شود.
- تغییرات Service Bus قبل از استفاده در محیط Production تست شوند.
Warning
تغییر Method، نوع Response یا قرارداد ورودی Service Bus می‌تواند روی مصرف‌کنندگان API اثر بگذارد. قبل از تغییرات، وابستگی‌های سرویس بررسی شوند.