WebAPI接口帮助文档详细说明

前段时间有个项目用到了webapi,不得不说,webapi的自动生成的接口帮助文档实在是太方便了。不过好用归好用,默认生成的文档还是有些小小的问题的,还需要稍微改良一下。

使用webapi生成的接口文档默认是这样子的,虽然我在接口和参数中都加了注释,然而并没有显示:
在这里插入图片描述
为了将注释显示出来,需要如下几个步骤:

1.必须先生成接口和Model参数的xml文档。方法如下:
分别选中Model项目和API项目【属性-生成-输出-XML文档文件】(其中Model项目XML为接口参数说明,API项目XML为接口方法说明),如下图所示:
在这里插入图片描述
2.生成好xml文档后,要配置到接口的帮助文档中,方法如下:
打开Areas/HelpPage/App_Start/HelpPageConfig.cs,注意看,原始文件中有如下一句代码:

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值