.Net WebApi入门简单基础认识(自动生成api文档和简单测试)

关于WebApi网上有很多官方的定义,具体的定义就不写了,这篇文章大概介绍一下WebApi的基础搭建。。关于我自己对WebApi的理解是“webapi是基于HTPP构建的服务框架,可以用于搭建基本全部的客户端访问的接口(例如浏览器、APP、智能设备等)”


新建WebApi项目
这里写图片描述
选择新建asp.net项目,选择WebApi模板,其他默认就可以了!
这里写图片描述
新建出来咋一看跟MVC的结构很相像,不过webapi不用管view页面,新建控制器的时候选择api控制器就好了!
这里写图片描述
新建一个Logins登录的Api控制器
这里写图片描述
WebApi方法命名有一定的格式(Http verb (GET, POST, PUT, DELETE)),如果你不按格式来就要自己方法头部定义,自动生成的xml文档注释是///里面的注释,先定义好注释,然后开启一下xml文档文件,打开webapi类库的属性(右键选择属性),打开xml文档生成(如下图),文档位置自己选择,但要与Areas/HelpPage/App_Start/HelpPageConfig.cs文件中如下图的代码中的位置相同!
这里写图片描述
这里写图片描述
到这里就能显示中文文档
这里写图片描述
随便点进去一个,没发现测试按钮是因为没有安装相应的测试插件,打开Nuget管理控制器,安装下下面图片中的Nuget包就能集成简单测试功能
这里写图片描述
这里写图片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章