[webapi] 如何在查看api时 显示api的说明

时间:2023-03-09 03:42:03
[webapi] 如何在查看api时  显示api的说明

首先在Controller的方法中 写上相关注释,如下图

[webapi] 如何在查看api时  显示api的说明

然后 右击webapi项目点属性.按照下图选择

红色框中内容要保持一致

[webapi] 如何在查看api时  显示api的说明

然后保存.

在项目中找到到这个文件Areas/HelpPage/App_Start/HelpConfig.cs

[webapi] 如何在查看api时  显示api的说明

双击打开,按照下图进行修改

[webapi] 如何在查看api时  显示api的说明

config.SetDocumentationProvider( new XmlDocumentationProvider ( HttpContext.Current.Server.MapPath( "~/App_Data/XmlDocument.xml" )));

然后预览此项目

路径 http://localhost:10643/Help

[webapi] 如何在查看api时  显示api的说明

点击链接进去后

[webapi] 如何在查看api时  显示api的说明