Asp .Net Core Web API的swagger 使用

 目前在做一个CMS练习项目，后台采用.net core 2.0 WebAPI 。为了更好滴前后端分离，后端提供完善的API文档是很必要的。我采用swagger来实现API文档的生成，当然也可以使用API-DOC等

 以下是我用swagger生成API的文档的步骤：

 一、下载引用 swagger包。（注意下载的版本）

 

二、在项目中配置swagger

 1)在startup.cs的ConfigureServices方法中添加如下内容：

services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info
                {
                    Version = "v1",
                    Title = "CMS API",
                    Description = "CMS 测试项目的API描述文档",
                });
                var basePath = AppContext.BaseDirectory;
                var xmlPath = Path.Combine(basePath, "CMS_Web_API.xml");
                options.IncludeXmlComments(xmlPath);
            });

2)在startup.cs的Configure方法中添加如下内容

app.UseSwagger();
            app.UseSwaggerUI(action =>
            {
                action.SwaggerEndpoint("/swagger/v1/swagger.json", "CMS API");
            });

运行项目，访问localhost:<port>/swagger就可以访问了

更多可参考：

https://github.com/domaindrivendev/Swashbuckle.AspNetCore

微软文档：https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/web-api-help-pages-using-swagger

对产生的一些类名没有写注释的报警信息，可参考：

http://www.sohu.com/a/153843607_464104