.Net Core WebApi 之 Swagger 注釋

問題：

　　上一篇文章我們已經可以通過Swagger生成的Web頁面對WebApi進行測試。先希望WebApi的具體方法有對應的注釋。

解決：

1：在StartUp.cs 中添加以下代碼：

  public void ConfigureServices(IServiceCollection services)
        { 
            services.AddControllers();

            // 注冊Swagger服務
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "My Demo API",
                    Version = "v1.0",
                    Description = "My Demo API"
                }
                );
                c.SwaggerDoc("v2", new OpenApiInfo
                {
                    Version = "v1.0",
                    Title = "基礎接口",
                    Description = "用戶登錄認證接口"
                });

                // 為 Swagger 設置xml文檔注釋路徑
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                // 添加控制器層注釋，true表示顯示控制器注釋
                c.IncludeXmlComments(xmlPath, true);
            });

        }

2：設置項目屬性--生成 頁面：如下圖

3：添加WebApi具體方法的注釋（略）

4：運行程序，顯示如下：