.net core3.1中swagger的使用

首先第一步，需要引入兩個包

在nuget管理器中分別搜索 Swashbuckle 和 Microsoft.DotNet

 

第一步，設置項目屬性

 

 

 第二步，服務注冊

 

 

 

private readonly string apiName = "基礎用戶信息服務";

           #region swagger
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("V1", new OpenApiInfo
                {
                    Version = "V1",//版本號
                    Title = $"{apiName} 接口文檔——dotnetcore 3.1",//編輯標題
                    Description = $"{apiName} HTTP API V1",//編輯描述
                    Contact = new OpenApiContact { Name = apiName, Email = "[e-mail]" },//編輯聯系方式
                    License = new OpenApiLicense { Name = apiName }//編輯許可證
                });
                c.OrderActionsBy(o => o.RelativePath);

                var xmlPath = Path.Combine(Microsoft.DotNet.PlatformAbstractions.ApplicationEnvironment.ApplicationBasePath, "MultilayerFrameworkSample.WebApi.xml");// 配置接口文檔文件路徑
                c.IncludeXmlComments(xmlPath, true); // 把接口文檔的路徑配置進去。第二個參數表示的是是否開啟包含對Controller的注釋容納
            });
            #endregion

第三步，添加swagger中間件

           #region swagger

            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint($"/swagger/V1/swagger.json", $"{apiName} V1");
                c.RoutePrefix = "";                
            });

            #endregion

第四步，修改launchSettings.json文件，讓網站一啟動的時候，自動進入swagger界面

 

 把這倆都改成空字符串即可。

第五步，在控制器和方法上寫上注釋，然后運行網站，查看效果