اضافه کردن Swagger به ASP.NET Core 2.0 Web API

یک پروژه ی ASP.NET Core 2.0 WEB API بسازید طراحی اپلیکیشن در مشهد و رایا پارس پکیج nuget به اسم Swashbuckle.AspNetCore را نصب فرمایید. Swashbuckle مشمول سه پکیج میباشد Swagger generator ، middleware برای علامت دادن Swagger ساخت‌و‌ساز گردیده تحت عنوان نقاط آخری JSON و middleware برای آرم دادن یک swagger-ui که به وسیله نقاط نهایی ساخت و ساز گردیده اند، میباشد. کل این مفاد میتوانند از روش پکیج چندگانه ی Swashbuckle.AspNetCore به طور پایین نصب شوند:

PM > Install-Package Swashbuckle.AspNetCore
template پیش فرض، ValuesContoller را با اکشن اسلوب API برای کلیه ی افعال HTTP دارااست. در‌این پست از همین template برای علامت دادن Swagger UI به کارگیری خوا‌هیم کرد.

فولدر Startup.cs را برای افزودن خدمت swagger به middleware مانند پایین گشوده نمایید:

public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info
{
Version = "v1",
Title = "My API",
Description = "My First ASP.NET Core Web API",
TermsOfService = "None",
Contact = new Contact() { Name = "Talking Dotnet", Email = "contact@talkingdotnet.com", Url = "www.talkingdotnet.com" }
});
});
}
و Swagger UI را در سیاق Configure() فعال فرمایید.

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}

app.UseMvc();
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
}
این کل چیزی بود که برای تهیه Swagger نیاز داریم. واپسین کاری که می بایست اعمال دهیم این میباشد که URL راه‌اندازی نرم‌افزار را تغییر و تحول دهیم تا Swagger UI روی launch بارگیری گردد. برای تهیه Swagger UI تحت عنوان URL اول روی Project راست کلیک فرمائید -> properties را گزینش فرمایید -> به زبانه ی debug بروید. در زبانه ی debug محتوای Launch Browser را به “swagger” تغییر‌و تحول دهید.