نمایش نام رشته ای enum ها در swagger

در اکثر پروژه‌های ASP.NET Core، وقتی از enumها در ورودی API استفاده می‌کنیم، ابزار Swagger مقادیر این enumها را به‌صورت عددی نمایش می‌دهد. این موضوع ممکن است برای توسعه‌دهنده‌ای که مستندات API را مطالعه می‌کند، کمی گیج‌کننده باشد؛ چون اعداد به‌تنهایی معنایی ندارند و مشخص نیست مثلاً مقدار ۲ یا ۴ به چه مفهومی اشاره دارد.

نمایش نام رشته ای enum ها در swagger

در اکثر پروژه‌های ASP.NET Core، وقتی از enumها در ورودی API استفاده می‌کنیم، ابزار Swagger مقادیر این enumها را به‌صورت عددی نمایش می‌دهد. این موضوع ممکن است برای توسعه‌دهنده‌ای که مستندات API را مطالعه می‌کند، کمی گیج‌کننده باشد؛ چون اعداد به‌تنهایی معنایی ندارند و مشخص نیست مثلاً مقدار ۲ یا ۴ به چه مفهومی اشاره دارد.

برای افزایش خوانایی و درک بهتر مستندات، بهتر است به‌جای اعداد، نام رشته‌ای مقادیر enum (مثل Active یا Pending) نمایش داده شود. این کار باعث می‌شود هم توسعه‌دهندگان راحت‌تر با API کار کنند و هم مستندات شما حرفه‌ای‌تر و واضح‌تر به‌نظر برسد.

در این مقاله با روش ساده‌ای آشنا می‌شوید که به کمک آن می‌توان enumها را در Swagger به‌شکل خوانا و کاربرپسند نمایش داد.

منبع  : باگتو

برای مشاهده کامل مطلب کلیک کنید

اشتراک‌گذاری

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *