使用 Swagger 自動生成 ASP.NET Core Web API 的文檔、在線幫助測試文檔（ASP.NET Core Web API 自動生成文檔）

對於開發人員來說，構建一個消費應用程序時去了解各種各樣的 API 是一個巨大的挑戰。
在你的 Web API 項目中使用 Swagger 的 .NET Core 封裝 Swashbuckle 可以幫助你創建良好的文檔和幫助頁面。 Swashbuckle 可以通過修改 Startup.cs 作為一組 NuGet 包方便的加入項目。
Swashbuckle 是一個開源項目，為使用 ASP.NET Core MVC 構建的 Web APIs 生成 Swagger 文檔。
Swagger 是一個機器可讀的 RESTful API 表現層，它可以支持交互式文檔、客戶端 SDK 的生成和可被發現。

Swashbuckle 有兩個核心的組件
Swashbuckle.SwaggerGen : 提供生成描述對象、方法、返回類型等的 JSON Swagger 文檔的功能。
Swashbuckle.SwaggerUI : 是一個嵌入式版本的 Swagger UI 工具，使用 Swagger UI 強大的富文本表現形式來可定制化的來描述 Web API 的功能，並且包含內置的公共方法測試工具。

新建一個ASP.NET Core WebApi 項目，項目結構如下圖所示：

使用NUget進行添加Swashbuckle

1、工具->NUget包管理器->程序包管理器控制台

2、在控制台輸入： Install-Package Swashbuckle -Pre  按下回車鍵

3、安裝Swashbuckle完成：

4、安裝Swashbuckle完成后台項目的引用發生了變化：

5、在 project.json 中添加多了一項配置 "Swashbuckle": "6.0.0-beta902" ：

7、啟用 XML 注釋， 在 Visual Studio 中右擊項目並且選擇 Properties 在 Output Settings 區域下面點擊 XML Documentation file 。

9、在 project.json 中設置 “xmlDoc”: true 來啟用 XML 注釋。

10、在Startup.cs類的 ConfigureServices 方法中，允許中間件提供和服務生成 JSON 文檔以及 SwaggerUI。Configure 方法中把 SwaggerGen 添加到 services 集合。配置 Swagger 使用生成的 XML 文件

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.PlatformAbstractions;
using Swashbuckle.Swagger.Model;

namespace dotNetCore_Test1
{

    public class Startup
    {
        public Startup(IHostingEnvironment env)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(env.ContentRootPath)
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true);

            if (env.IsEnvironment("Development"))
            {
                // This will push telemetry data through Application Insights pipeline faster, allowing you to view results immediately.
                builder.AddApplicationInsightsSettings(developerMode: true);
            }
            builder.AddEnvironmentVariables();
            Configuration = builder.Build();
        }

        public IConfigurationRoot Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container
        public void ConfigureServices(IServiceCollection services)
        {
            // Add framework services.
            services.AddApplicationInsightsTelemetry(Configuration);

            services.AddMvc();

            //services.AddLogging();

            // 注入的實現ISwaggerProvider使用默認設置
            services.AddSwaggerGen();

            services.ConfigureSwaggerGen(options =>
            {
                options.SingleApiVersion(new Info
                {
                    Version = "v1",
                    Title = "測試ASP.NET Core WebAPI生成文檔（文檔說明）",
                    Description = "A simple example ASP.NET Core Web API",
                    TermsOfService = "None",
                    Contact = new Contact { Name = "linyongjie", Email = "", Url = "https://docs.microsoft.com/zh-cn/aspnet/core/" },
                    License = new License { Name = "Swagger官網", Url = "http://swagger.io/" }
                });

                var basePath = Microsoft.Extensions.PlatformAbstractions.PlatformServices.Default.Application.ApplicationBasePath; // 獲取到應用程序的根路徑
                options.IncludeXmlComments(basePath + "\\dotNetCore_Test1.xml");  //是需要設置 XML 注釋文件的完整路徑
            });

            
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline
        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
        {
            loggerFactory.AddConsole(Configuration.GetSection("Logging"));
            loggerFactory.AddDebug();

            app.UseApplicationInsightsRequestTelemetry();

            app.UseApplicationInsightsExceptionTelemetry();

            app.UseMvc();


            app.UseSwagger(); //使中間件服務生成Swagger作為JSON端點

            app.UseSwaggerUi();  //使中間件服務swagger-ui assets (HTML、javascript、CSS等等)

        }
    }
}

11、新建一個User（用戶）Model用於測試：

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Threading.Tasks;

namespace dotNetCore_Test1.Models
{
    
    /// <summary>
    /// 用戶模型
    /// </summary>
    public class User
    {
        

        /// <summary>
        /// 年齡
        /// </summary>
        public int Age { set; get; }

        /// <summary>
        /// 名稱
        /// </summary>
        [Required]  //此配置可以約束(Swagger )傳進來的參數值 不能為空
        public string Name { get; set; }


        /// <summary>
        /// 性別
        /// </summary>
        public string Sex { get; set; }
    }
}

12、添加了XML注釋控制器例子：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;

namespace dotNetCore_Test1.Controllers
{
    /// <summary>
    /// 測試 Swagger的 XML 注釋
    /// </summary>
    [Route("api/[controller]")]
    public class ValuesController : Controller
    {
        /// <summary>
        /// 獲得一個數組信息
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }

        /// <summary>
        /// 根據id獲取信息
        /// </summary>
        /// <param name="id">主鍵唯一標識</param>
        /// <returns>返回一個值</returns>
        [HttpGet("{id}")]
        public string Get(int id)
        {
            return "value";
        }

        /// <summary>
        /// 添加一個用戶
        /// </summary>
        /// <remarks>
        ///  
        ///     POST /User
        ///     {
        ///        "Age": "年齡",
        ///        "Name": "名稱",
        ///        "Sex": "性別
        ///     }
        /// 
        /// </remarks>
        /// <param name="item">用戶的json對象</param>
        /// <returns>返回一個對象</returns>
        /// <response code="201">返回新創建的項目</response>
        /// <response code="400">如果item是null</response>
        [HttpPost]
        [ProducesResponseType(typeof(dotNetCore_Test1.Models.User), 201)]
        [ProducesResponseType(typeof(dotNetCore_Test1.Models.User), 400)]
        [HttpPost]
        public IActionResult Post([FromBody]dotNetCore_Test1.Models.User item)
        {
            if (item == null)
            {
                return BadRequest();
            }
            return Ok(item);
        }



        
        /// <summary>
        /// 刪除一個對象
        /// </summary>
        /// <remarks>
        /// 這里可以寫詳細的備注
        /// </remarks>
        /// <param name="id">主鍵id標識</param>
        [HttpDelete("{id}")]
        public void Delete(int id)
        {
        }
    }
}

13、通過訪問 http://localhost:<random_port>/swagger/ui 查看Swagger 自動生成文檔 （<random_port> 表示IIS Express隨機分配的端口號，我測試的demo分配的端口號是：51109，所以我這里查看Swagger生成的文檔地址是http://localhost:51109/swagger/ui/index.html#/Values）生成的文檔如下圖：

13.1、

13.2

13.3

13.4

配置 Swagger 使用生成的 XML 文件