‫تغییر روش ASP.NET در تولید نام‌های طرحواره OpenAPI

ASP.NET به طور پیش‌فرض نام‌های طرحواره OpenAPI را بر اساس نام مدل‌ها تولید می‌کند. با این حال، در برخی موارد ممکن است بخواهید این نام‌ها را برای تناسب بهتر با طراحی API خود سفارشی کنید، به عنوان مثال برای جلوگیری از تداخل نام‌ها. این مقاله به بررسی نحوه تغییر روش تولید نام‌های طرحواره OpenAPI در ASP.NET می‌پردازد. برای فعال‌سازی OpenAPI در برنامه ASP.NET خود، باید سرویس‌ها و میانی‌افزار OpenAPI را با استفاده از روش‌های AddOpenApi و MapOpenApi اضافه کنید. این کار باعث ایجاد یک سند OpenAPI می‌شود که نقاط پایانی و مدل‌های API شما را توصیف می‌کند و در آدرس /openapi/v1.json قابل دسترسی است. مشکلاتی در مورد تداخل نام مدل‌ها در فضای نام‌های مختلف وجود دارد. به عنوان مثال، ممکن است دو کلاس با نام ResponseData در فضای نام‌های جداگانه داشته باشید. در هنگام تولید مستندات OpenAPI، هر دو کلاس به عنوان ResponseData نمایش داده می‌شوند که منجر به تداخل می‌شود. این امر باعث ابهام در مستندات API و شکست ابزارهای تولید کد که به نام‌های طرحواره منحصربه‌فرد متکی هستند، می‌شود. برای رفع این مشکل، می‌توان از روش CreateSchemaReferenceId برای سفارشی‌سازی استراتژی نام‌گذاری طرحواره استفاده کرد. این روش به شما امکان می‌دهد نام‌های منحصربه‌فردی برای طرحواره‌های OpenAPI خود ایجاد کنید و از تداخل نام‌ها جلوگیری کنید. با استفاده از این روش، می‌توانید اطمینان حاصل کنید که مستندات API شما دقیق و قابل اعتماد است و ابزارهای تولید کد به درستی کار می‌کنند.