WebAPI2.0自动生成帮助文档设置

[TOC]

创建一个WebApi项目之后，在项目的Areas文件夹中自动创建了一个域，这个域中的代码就是api的说明文档内容，直接运行项目在 `http://localhost:***/Help` 路径下就可以看到API的介绍了，但是这个时候的只给出了接口名称，接口的说明都没有显示，下面就要做一些设置让我们代码中的注释变成接口的说明

+ 第一步：选中项目-》右键属性-》生成-》勾选XML文档文件-》保存
<img src="/UploadFiles/images/20220508/6378763380358882482388248.png" style="width:1050px;"/>

+ 第二步：找到/Areas/HelpPage/App_Start/HelpPageConfig.cs文件，修改文件中的Register方法
<img src="/UploadFiles/images/20220508/6378763399858078688732600.png" style="width:300px;"/>

+ 第三步：在Register方法中添加下面这段代码，xml文件的路径就是第二步中勾选【XML文档文件】时设置的路径
```csharp
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/OpenApi.xml")));
```

+ 第四步：设置完后我们需要注意代码的注释规范，要显示到帮助文档中要遵循三行注释规范
```csharp
/// <summary>
/// 三国人物信息
/// </summary>
/// <returns>list</returns>
public IEnumerable<ThreeCountries.Person> GetPersonInfos()
{
   List<ThreeCountries.Person> list = new List<ThreeCountries.Person>();
   return list;
}
```

**效果展示：**