ASP.NET Web API入门教程【6】- 接口描述文档

 时间:2024-10-30 14:34:52

1、在上一篇【ASP.NET Web API入门教程【5】- 按方法名调用】创建的项目上添加描述文档

ASP.NET Web API入门教程【6】- 接口描述文档

2、在项目上点击右键 ->【管理 NuGet 程序包】

ASP.NET Web API入门教程【6】- 接口描述文档

3、在NuGet界面,点击【浏览】-> 输入【help】,待搜索完成后,选择【Microsoft.AspNet.WebApi.HelpPage】,在右侧点击【安装】,之后弹出的各种确认框,都点击确定即可 安装完成后,会在项目中增加【Areas】文件夹,并包含很多文件与代码

ASP.NET Web API入门教程【6】- 接口描述文档
ASP.NET Web API入门教程【6】- 接口描述文档

4、在【Global.asax】文件的【Application_Start】方法中增加【AreaRegistration.RegisterAllAreas();】,可能需要引入【using System.Web.Mvc;】

ASP.NET Web API入门教程【6】- 接口描述文档

5、在【DefaultController】的Get方法上添加注释,然后,运行项目,并修改地址,展示Help页面(此时并没有按照预期显示方法上面的描述)

ASP.NET Web API入门教程【6】- 接口描述文档
ASP.NET Web API入门教程【6】- 接口描述文档
ASP.NET Web API入门教程【6】- 接口描述文档

6、【显示接口描述】 1)取消【Areas\HelpPage\App_Start\HelpPageConfig.cs】文件中Register方法的部分注释 2)在项目上点击右键 ->【属性】->【生成】->【输出】-> 勾选【XML 文档文件】,并设置路径 3)在Controller中添加新接口与注释 4)注意:重新编译后,会在【App_Data】文件夹下面生成【XmlDocument.xml】文件,默认并没有包含在项目中,可以点击【显示所有文件】按钮将其包含到项目中,发布时也需要此文件

ASP.NET Web API入门教程【6】- 接口描述文档
ASP.NET Web API入门教程【6】- 接口描述文档
ASP.NET Web API入门教程【6】- 接口描述文档
ASP.NET Web API入门教程【6】- 接口描述文档
ASP.NET Web API入门教程【6】- 接口描述文档

7、再次运行,即可看到接口的描述,点击接口还可以看到参数等各种详细信息

ASP.NET Web API入门教程【6】- 接口描述文档
  • 道路边的小树怎样养护
  • 【校园指南】武昌首义学院周末周边游篇
  • 国家如何才能留住人才?
  • 哈利波特魔法觉醒魔药怎么制作
  • 如何培养好奇心
  • 热门搜索
    关于安全教育的手抄报 我的理想手抄报 国庆节手抄报图片大全 小学生科技手抄报 节能减排手抄报 祖国在我心中手抄报内容 世界地球日手抄报内容 关于诚信的手抄报 劳动手抄报简单一等奖 抗疫情手抄报