پیاده سازی Swagger,ApiVersion در web api core 3

قبل از اینکه وارد بحث بشیم یک مقدمه ساده درباره دو Swagger , ApiVersion تشریح خواهیم کرد.

توجه!برای خواندن این مقاله باید با web api در asp core 3 اشنایی داشته باشید

؛ Swagger : وقتی شما یک وب سرویس رو مینویسید و میخوایید نحوره کار باهاش رو به کلاینت کار بدید چند روش وجود داره.کاری که بیشتر برنامه نویسا انجام میدن نوشتن داکیومت مربوط به وب سرویس ها همچنین نحوه فراخوانی ان در postman میباشد که روش معقول و پسندیده ای میباشد.

؛ postman یک برنامه قدرتمند برای فرخوانی ، تست و.. وب سرویس ها میباشد .شما میتوانید در این لینک به صورت کامل Postman رو مطالعه کنید.میتوانید بسته به سیستم عامل خود آن را دانلود کنید و همچنین میتوانید نسخه کروم ان رو بر رویه مرورگر خود نصب کنید ولی توسه میشود نسخه مربوط به سیستم عمل ان را نصب کنید

همانطور که گفته شد نوشتن داکیومت با Postman یک روش معقول میباشد و توسیه میشود حتما انجام داد!

ولی روش های دیگه ای وجود دارد که شما علاوه بر Postman میتوانید به پروژه خود اضافه کنید.کتاب خانه های مختلفی برای این کار وجود دارن که به راحتی میتوان نصب کرد

؛ swagger : یک کتاب خانه سورس باز میباشد که به راحتی رو پروژه نصب میشود و یک نما ساده و از وب سرویس ها نمایش میدهد.شما با Swagger برای هر وب سرویس خود میتوانید داکیومن بنویسید و نوع خروجی و ورودی ها رو نمایش بدید. نحوه نصب ان برای اکثر زبان های برنامه نویس موجود می باشد .

ما در این مقاله از asp core 3 استفاده میکنیم

نصب آن بر رویه asp core 3 بسیار ساده است و با نوشتن چند دستور ساده میتوانید آن را نصب کنید ولی ما میخوایم علاوه به Api Version ، Swagger هم داشته باشیم.

؛ Api Version : فرض کنید شما پروژتون Stable شده و کلاینت ها دارن استفاده میکنن ولی به هر دلیلی مثلا میخواید علاوه بر اپلیکشین اندروید فعلی یک اپلیکیشن دیگه با امکانات جدیدتر بزنید شما نباید به وب سرویس های فعلی خود دست بزنید و همزمان باید وب سرویس هارو ویرایش یا اضافه کنید!یک راه دیگه نوشتن یک پروژه جدید میباشد که از نظر کاری ممکنه زمان بر باشه و زیاد جالب نیست!

راه دیگه نوشتن api version برای وب سرویس هایمان است به این معنی وب سریس های فعلی باقی بمانند و شروع به توشتن وب سریس جدید با ورژن جدید بکنیم بدون اینکه تغیر در حالت فعلی به وجود بیاید.

توجه کنید api version را باید هنگام ساخت پروژه لحاظ کنید چون بعد از اینکه کلاینت کار از نسخه بدون ورژن استفاده کنند مشکل ساز خواهد بود که به ادرس جدید دیگه ای را فرواخوانی کنند

اگه شما از نسخه core 2 استفاده میتوانید از این مقاله به صورت کامل آن را پیاده سازی کنید ولی برای نسخه 3 باید طبق همین مقاله پیش برید.

برای شروع یک پروژه از نوع web api با دستور زیر ایجاد کنید

dotnet new webapi

پس از نصب با دستور dornet run از صحت اجرا پروژه مطمن شوید

وارد .csproj شوید و پکیج های زیر را نصب کنید هم.github

12 <PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning" Version="3.0.0" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="5.0.0-rc5" />

همچنین در فایل جاری تنظیمات زیر را انجام دهید.

12345678910111213141516171819202122 <Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>netcoreapp3.1</TargetFramework>
<RootNamespace>Versioning_ASP.Net_Core_3_APIs_with_Swashbuckle</RootNamespace>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="3.1.0" />
<PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="3.1.0" />
<PackageReference Include="Microsoft.TypeScript.MSBuild" Version="3.7.4">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning" Version="4.1.0" />
<PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="3.1.0" />
<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="3.1.0" />
<PackageReference Include="Microsoft.Extensions.PlatformAbstractions" Version="1.1.0" />
<PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="3.1.0" />
<PackageReference Include="NLog.Web.AspNetCore" Version="4.9.0" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="5.0.0-rc5" />
</ItemGroup>
</Project>

بعد با دستور زیر پکیج ها رو نصب کنید dotnet restore البته به محض ذخیره کردن به صورت اتوماتیک و پکیجا نصب میشن.

وارد پوشه Comtroller شوید و دو پوشه به نام v1 و v2 ایجاد کنید و همچنین درون هر پوشه دو کنترل با نام های ApiVersion بسازید.وارد پوشه v1 شوید و ApiController را به شکل زیر پیاده سازی کنید.github

123456789
[ApiVersion("1")]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiController]
public class ApiVersionController : ControllerBase
{
[HttpGet()]
public string Get() => "Space Potatoes v1"
}

توجه کنید ما فقط یک Controller تستی ایجاد کردیم با یک متد که یک متن رشته ای رو برگشت میده

وارد د پوشه v2 شوید و ApiController را به شکل زیر پیاده سازی کنید.github

12345678[ApiVersion("2")]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiController]
public class ApiVersionController:ControllerBase
{
[HttpGet()]
public string Get() => "Space Potatoes v2"
}

برای اینکه بتوانیم به صورت داینامیک هر چند ورژنی که تمایل داشتیم داشته باشیم در Root پروژه یک پوشه به نام Swagger ساخته و دو کلاس زیر را در ان ایجاد کنید. RemoveVersionParameterOperationFilter

123456789public class RemoveVersionParameterOperationFilter : IOperationFilter
  {
  public void Apply(OpenApiOperation operation, OperationFilterContext context)
        {
            // Remove version parameter from all Operations
            var versionParameter = operation.Parameters.Single(p => p.Name == "version");
            operation.Parameters.Remove(versionParameter);
        }
    }

؛ SetVersionInPathDocumentFilter

1234567891011 public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
        {
            var updatedPaths = new OpenApiPaths();
            foreach (var entry in swaggerDoc.Paths)
            {
                updatedPaths.Add(
                    entry.Key.Replace("v{version}", swaggerDoc.Info.Version),
                    entry.Value);
            }
            swaggerDoc.Paths = updatedPaths;
        }

در نهایت وارد Startup شوید و به صورت زیر آن را کانفیگ کنید

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }
        public IConfiguration Configuration { get; }
        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
 
            services.AddControllers();
             services.AddApiVersioning(o =>
            {
                o.ReportApiVersions = true;
                o.AssumeDefaultVersionWhenUnspecified = true;
                o.DefaultApiVersion = new ApiVersion(1, 0);
            });
 
            services.AddSwaggerGen(option =>
            {
                option.SwaggerDoc("WithsaltWebApiDemo", new OpenApiInfo
                {
                    Version = "v1",
                    Title = "WithsaltWebApiDemo API",
                    Description = "API for WithsaltWebApiDemo",
                    Contact = new OpenApiContact() { Name = "withsalt", Email = "[email protected]" }
                });


                option.SwaggerDoc("v1", new OpenApiInfo { Version = "v1", Title = "API V1" });
                option.SwaggerDoc("v2", new OpenApiInfo { Version = "v2", Title = "API V2" });


                option.DocInclusionPredicate((docName, apiDesc) =>
                {
                    var versions = apiDesc.CustomAttributes()
                        .OfType<ApiVersi>()
                        .SelectMany(attr => attr.Versions);


                    return versions.Any(v => $"v{v.ToString()}" == docName);
                });


                option.OperationFilter<RemoveVersionParameterOperationFilter>();
                option.DocumentFilter<SetVersionInPathDocumentFilter>();


                // include document file
                option.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, $"{typeof(Startup).Assembly.GetName().Name}.xml"), true);
                option.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, $"Versioning-ASP.Net-Core-3-APIs-with-Swashbuckle.xml"), true);
            });


            services.AddControllers()
                .AddNewtonsoftJson(options =>
                {
                    options.SerializerSettings.ContractResolver = new DefaultContractResolver();
                });
        }


        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExcepti();
            }
            app.UseHttpsRedirection();
            app.UseRouting();
            app.UseAuthorization();
            app.UseEndpoints(endpoints =>{endpoints.MapControllers();});
            app.UseStaticFiles();
             app.UseSwagger();
            //Enable middleware to serve swagger-ui (HTML, JS, CSS etc.), specifying the Swagger JSON endpoint
            app.UseSwaggerUI(option =>
            {
                option.SwaggerEndpoint("/swagger/v2/swagger.json", "V2 Docs");
                option.SwaggerEndpoint("/swagger/v1/swagger.json", "V1 Docs");


                option.RoutePrefix = string.Empty;
                option.DocumentTitle = "WithsaltWebApiDemo API"
            });
        }
}

اکنون یک بار دیگر پروژه را اجرا کنید این بار خرجی به شکل زیر خواهد بود که در گوشه سمت راست بالا میتوانید ورژن وب سرویس های خودتون رو انتخاب کنید و بر رویه هر وب سرویس کلیک کنید میتوانید به سادگی ان را فرخوانی کنید

هدف این مقاله ورژن بندی در Swagger بود.شما میتوانید به یک سرچ ساده Swagger با به صورت پیشرفته تر کانفیگ کنید.

میتوان Swagger Version را به سادگی نصب کرد ولی مشکلی که خودم در چندین ساعت روش کار کردم این بود که تو نسخه Core 3 خیلی خطا زیادی داره هرچقد سرچ کردم اخرش با یک سایت چینی تونستم در ورژن 3 همه Api Version رو بالا بیارم

https://github.com/SobhanPlusPlus

اگه از مقاله راضی بودید میتونید از لینک زیر برام قهوه بخرید : )

https://www.coffeete.ir/sobhan

Sobhan – Overview
A day without ( learning | laughter ) is a lost day

coffeete.ir

نویسنده مطلب: Sobi

منبع مطلب