.NetCore WebApi —— Swagger版本控制

時間 2019-11-12

標籤 netcore webapi swagger 版本控制简体版

原文原文鏈接

目錄：html

.NetCore WebApi——Swagger簡單配置git

.NetCore WebApi——基於JWT的簡單身份認證與受權（Swagger）github

.NetCore WebApi —— Swagger版本控制json

版本控制的好處是顯而易見的，利用Swagger展現不一樣版本的API更能體現效果。架構

1.安裝Nuget包：Microsoft.AspNetCore.Mvc.Versioningapp

2. 配置Startup類ide

2.1 添加新成員，用來獲取API版本信息ui

　　　　　/// <summary>
        /// Api版本信息
        /// </summary>
        private IApiVersionDescriptionProvider provider;

2.2 在 ConfigureServices 方法中註冊服務this

services.AddApiVersioning(option =>
            {
                // 可選，爲true時API返回支持的版本信息
                option.ReportApiVersions = true;
                // 不提供版本時，默認爲1.0
                option.AssumeDefaultVersionWhenUnspecified = true;
                // 請求中未指定版本時默認爲1.0
                option.DefaultApiVersion = new ApiVersion(1, 0);
            }).AddVersionedApiExplorer(option =>
            {
　　　　　　　　　　// 版本名的格式：v+版本號
                option.GroupNameFormat = "'v'V";
                option.AssumeDefaultVersionWhenUnspecified = true;
            });

            this.provider = services.BuildServiceProvider().GetRequiredService<IApiVersionDescriptionProvider>();

2.3 遍歷API版本信息，在原有的AddSwaggerGen方法中循環處理：紅色部分spa

           // 註冊Swagger服務
            services.AddSwaggerGen(c =>
            {
                // 多版本控制
                foreach (var item in provider.ApiVersionDescriptions)
                {
                    // 添加文檔信息
                    c.SwaggerDoc(item.GroupName, new Info
                    {
                        Title = "CoreWebApi",
                        Version = item.ApiVersion.ToString(),
                        Description = "ASP.NET CORE WebApi",
                        Contact = new Contact
                        {
                            Name = "Jee",
                            Email = "xiaomaprincess@gmail.com",
                            Url = "https://www.cnblogs.com/jixiaosa/"
                        }
                    });
                }

2.4 修改 Configure 方法中的 SwaggerUI方法，一樣作循環處理

　　　　　　　// 配置SwaggerUI
            app.UseSwaggerUI(c =>
            {
                foreach (var item in provider.ApiVersionDescriptions)
                {
                    //c.SwaggerEndpoint("/swagger/v1/swagger.json", "CoreAPI"); 單版本
                    c.SwaggerEndpoint($"/swagger/{item.GroupName}/swagger.json", "CoreAPI"+item.ApiVersion);
                }
                c.RoutePrefix = string.Empty;
            });