asp.net core webAPI学习笔记（七）生成帮助文档

IDE 版本：Visual Studio 2017 15.9.7
asp.net core 版本 2.1.1

本文档说明需在
asp.net core webAPI学习笔记（一）项目搭建
的基础下进行

打开NuGet包管理

引入Swashbuckle.AspNetCore

Startup.cs
添加引用

using Swashbuckle.AspNetCore.Swagger;

ConfigureServices添加代码

services.AddSwaggerGen(c =>
{
     c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
 });

Configure添加代码，要放在app.UseMvc(); 前面

app.UseSwagger();

app.UseSwaggerUI(c =>
 {
     c.SwaggerEndpoint("/swagger/v1/swagger.json", "HelpPage V1");
 });

运行项目，url输入https://localhost:44377/swagger/index.html，端口号改成自己的

开启注释

开启XML文档文件，设置生成路径

swagger配置xml文档路径

var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径）
var xmlPath = Path.Combine(basePath, "API_dev_test.xml");
c.IncludeXmlComments(xmlPath);

控制器方法添加注释

启动项目