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

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

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

红色框中内容要保持一致

然后保存.

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

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

然后预览此项目

路径 http://localhost:10643/Help

点击链接进去后

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

时间: 2024-08-14 21:35:34

[webapi] 如何在查看api时 显示api的说明的相关文章

Linux故障:linux中使用ifconfig命令查看网卡信息时显示为eth1,但是在network-scripts中只有ifcfg-eth0的配置文件,并且里面的NAME="eth0"。

除了题目中的问题,其实在执行命令:service network restart时,会报错: 解决办法: 首先需要修改70-persistent-net.rules文件: vim /etc/udev/rules.d/70-persistent-net.rules 然后修改ifcfg-eth0文件: vim /etc/sysconfig/network-scripts/ifcfg-eth0 最后:重启网络:service network restart 如果ifconfig命令下,eth1没有改变

[精通Objective-C]进阶技巧:使用运行时系统API

[精通Objective-C]进阶技巧:使用运行时系统API 参考书籍:<精通Objective-C>[美] Keith Lee 什么是运行时系统? 目录 精通Objective-C进阶技巧使用运行时系统API 目录 动态加载可选包 创建命令行程序 创建可选包 传入包路径 使用可选包 运行时系统API 动态代理 创建实现横切功能的协议和类 编写代理类 添加代理的目标类 测试动态代理程序 动态加载可选包 下面是使用NSbundle API动态加载自己编写的框架包的示例,共需要创建两个工程,一个命

ArcGIS JavaScript + 天地图API之显示混乱

原文:ArcGIS JavaScript + 天地图API之显示混乱  异常描述: (1)ArcGIS JavaScript 调用天地图WMTS服务,出现了这种混乱的效果,加载不完整. (2)昨天是相关瓦片的请求,Google浏览器显示的是请求失败.当时怀疑是无线网络的问题,接了有线,还是请求失败.以为是别人的问题,过几天应该就好了,所以也没放在心上 (3)今天一调试发现所有的请求都可以正常响应,可地图却仍然混乱 可能问题猜测: (1)天地图WMTS服务的问题 (2)坐标系的问题,可能是坐标系的

.NET Core WebApi帮助文档使用Swagger生成Api说明文档

Swagger也称为Open API,Swagger从API文档中手动完成工作,并提供一系列用于生成,可视化和维护API文档的解决方案.简单的说就是一款让你更好的书写API文档的框架. 我们为什么选择swagger,现在的网站开发结果越来越注重前后端的分离,比如以前的webFrom到现在的mvc模式都是为了这个前后端的分离.就算再如何的分离实现,也是不可避免的要进行数据交互的,那么接口的重要性就提现出来了.他成了前端和后端交互的重要途径,API文档也因此成了前端开发人员与后端开发人员的重要纽带.

WebApi系列~基于RESTful标准的Web Api

WebApi系列~基于RESTful标准的Web Api 回到目录 微软的web api是在vs2012上的mvc4项目绑定发行的,它提出的web api是完全基于RESTful标准的,完全不同于之前的(同是SOAP协议的)wcf和webService,它是简单,代码可读性强的,上手快的,如果要拿它和web服务相比,我会说,它的接口更标准,更清晰,没有混乱的方法名称,有的只有几种标准的请求,如get,post,put,delete等,它们分别对应的几个操作,下面讲一下: GET:生到数据列表(默

json_encode在设计api时需要注意的问题

在设计api时我们经常会使用关联数组,例如:我要返回给客户端主题信息和主题包列表 原始数组格式 $arr = array( 100=>array('themeName'=>'a','files'=>array('1.jpg','2.jpg')), 200=>array('themeName'=>'b','files'=>array('1.jpg','2.jpg')), 300=>array('themeName'=>'c','files'=>array

程序开发使用地图API时需注意的问题(转)

最近在做一个基于地点提醒的移动应用,当初考虑大家都心知肚明的原因,谨慎的选择了百度地图,现在想想其实完全没有必要,好的应用本来就不分国界的,最后可能还是得换回Google地图.毕竟Google地图在技术和成熟度上完胜百度地图,当然百度也在慢慢追赶,希望有一天大家都能用上咱们自己的好用的地图服务. 现在把碰到的问题和解决方案罗列一下: 版权:如果是大量商用的话,还是得事先注意一下版权意识,不然到时候就很被动了.两者的免费版都不允许商业应用,具体可以看这里Google Maps API,百度API常

[dev] Go语言查看doc与生成API doc

类似与javadoc,go也可以自动生成doc文档. 方法有两个: 1. 使用go doc工具 可以查看它的详细文档: go help doc 示例: 在这个目录下,我创建一个api包 ╰─>$ pwd /home/tong/Src/go/src/local/test/api/api.go 代码是这样的: package api import "fmt" type TestApi struct { var1 int var2 int var3 string Var4 int Va

Xcode小技巧:使用代码块+查看某行代码作者+运行时显示控件边框

1.如果使用 git 来开发,可以快速定位你现在看不懂的代码是哪个2货写的,然后即使把锅甩到他身上(ps:如果是自己写的,你就默不作声,别让别人知道这个技巧哈),其实就是 show blame for line. 2.有句话说的好,聪明的程序员懂得"偷懒"来提升开发效率.我们在日常开发中,有一些代码片段会经常利用到,大家可能会觉得定义一些宏可以解决问题,但是遇到比如,UITableView的协议方法,或者写Demo时候想要快速的定义一个UIButton(当然,你用storyboard除