/
/
/
/
Static Backend Parameters قابلیتی در Service Bus است که امکان تعریف مقدارهای ثابت سمت Backend را فراهم می‌کند. این قابلیت برای کنترل قرارداد ورودی API و جلوگیری از ارسال برخی پارامترها توسط Consumer استفاده می‌شود.
Static Backend Parameters چیست؟
در Service Bus ممکن است یک Provider دارای Parameterهایی باشد که نباید توسط مصرف‌کننده API ارسال یا تغییر داده شوند. در این شرایط می‌توان مقدار مورد نظر را به‌صورت Static Backend Parameter تعریف کرد.
در این حالت مقدار Parameter در سمت Backend مشخص می‌شود و Consumer فقط API منتشرشده را فراخوانی می‌کند.
نکته مهم
Static Backend Parameter با Constant/Default در REST Provider متفاوت است و رفتار آن نباید با مقدار پیش‌فرض Parameter اشتباه گرفته شود.
جایگاه Static Backend Parameter در Service Bus
Consumer Request
↓
Service Bus
↓
Static Backend Parameter
↓
Provider
قرارداد ورودی API
زمانی که یک Parameter به‌صورت Static Backend تعریف می‌شود، آن Parameter بخشی از ورودی قابل کنترل توسط Consumer نیست و مقدار آن در Backend مدیریت می‌شود.
مثال
Provider Parameter: FromUserId Static Backend Value: 1000
در این حالت Consumer نیازی به ارسال FromUserId ندارد و Service Bus مقدار ثابت تعریف‌شده را برای اجرای Provider استفاده می‌کند.
Consumer Request:
{
}
Backend:
FromUserId = 1000
Provider Execution:
FromUserId = 1000تفاوت Static Backend Parameter با REST Constant/Default
| موضوع | REST Constant / Default | Service Bus Static Backend Parameter |
|---|---|---|
| هدف | تعیین مقدار پیش‌فرض Parameter | تعیین مقدار ثابت Backend |
| اگر Consumer مقدار ارسال نکند | Default استفاده می‌شود | Static Value استفاده می‌شود |
| اگر Consumer مقدار ارسال کند | مقدار Consumer می‌تواند استفاده شود | مقدار Static Backend برای اجرای نهایی اعمال می‌شود |
| نمایش برای Consumer | بسته به Contract سرویس | به‌عنوان ورودی آزاد Consumer ارائه نمی‌شود |
سناریوی استفاده
فرض کنید یک Provider برای دریافت اطلاعات کاربران وجود دارد و باید فقط اطلاعات یک سازمان مشخص از طریق API منتشر شود.
- Provider دارای Parameter سازمان است.
- Service Bus مقدار سازمان را به‌صورت Static Backend تعریف می‌کند.
- Consumer فقط API را فراخوانی می‌کند.
- Provider با مقدار ثابت Backend اجرا می‌شود.
نکات طراحی
- Parameterهای ثابت فقط برای مقادیری استفاده شوند که باید توسط Backend کنترل شوند.
- Contract API باید برای Consumer شفاف باشد.
- مقادیر حساس نباید در مثال‌ها یا مستندات عمومی قرار گیرند.
- تغییر Static Parameter می‌تواند رفتار API منتشرشده را تغییر دهد.
Warning
Static Backend Parameter نباید با REST Constant/Default یا Secret Storage یکسان در نظر گرفته شود. این قابلیت فقط برای کنترل مقدار ورودی در لایه Service Bus استفاده می‌شود.