如何使 WebAPI 自动生成漂亮又实用在线API文档

1、如何引入组件

首先，我们需要定义一个API项目

然后通过Nuget引入组件。记住选下图中的第三个。

引入成功后，将向项目里面添加一些主要文件：

•Scripts\WebApiTestClient.js

•Areas\HelpPage\TestClient.css

•Areas\HelpPage\Views\Help\DisplayTemplates\TestClientDialogs.cshtml

•Areas\HelpPage\Views\Help\DisplayTemplates\TestClientReferences.cshtml

2、如何使用组件

1、修改Api.cshtml文件

通过上述步骤，就能将组件WebAPITestClient引入进来。下面我们只需要做一件事：打开文件 (根据 Areas\HelpPage\Views\Help) Api.cshtml 并添加以下内容:

•@Html.DisplayForModel("TestClientDialogs")

•@Html.DisplayForModel("TestClientReferences")

、新建WebAPI的项目

1. 在Web下，ASP.NET Web 应用程序，点击确定

2. 点击确定

3. 如图所示， 新建Controller

4 . 运行项目

二、注释

1. 在生成中，勾选xml文档文件（生成注释文件）

2. 修改HelpPageCofig，添加项目的APl.xml的配置

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath(@"bin/RFD.Railway.Tool.xml")))

3. 如图所示，写API内容，运行项目

4. 配置Global.asax，XPO注册信息

5. 如图所示，API页面，生成注释

三、Test API

1. 添加WebApiTestClient的dll

2. 更新dll

3. 如图所示，再Api.cshtml中，添加一行代码

@Html.DisplayForModel("TestClientDialogs") @section Scripts{<link href="~/Areas/HelpPage.css"rel="stylesheet"/[email protected]("TestClientReferences") }

4. 如图所示，已生成TestAPI按钮

5. 用TestAPI，在API页面，直接测试接口

---