说明:
1)以下以
.NET为开发平台创建api接口,并且引入Swagger配置接口文档
2)
代码部分有点混乱,可转到文章底部有文章链接查看一、创建Net Web API项目
1.新建web应用程序
2.选择空模板,并且勾选web api
3.生成web api项目后,添加controller文件
4.自动回生成content、views等文件夹及文件
5.可直接运行,程序异常
6.Global.asax 添加配置
代码如下:
7.修改路由配置,制定默认controller、action
代码如下:
8.生成默认view
9.重新编译,运行程序。成功显示home的index页面
二、引入Swagger
1.打开NuGet程序包
2.“浏览”页签下,搜索swagger, 找到swashbuckle,右侧选择webapi项目,进行安装。
3.找到swagger.net.ui,右侧选择webapi项目,进行安装。
4.安装完成后,生成相关配置文件,可直接关闭掉nuget,
三、配置Swagger
1.修改默认页(前面步骤中生成的HomeController的index页面仅仅是测试用,到此步骤也可以删除掉)
代码如下:
2.运行程序,出现报错,因为还缺少配置
3.打开应用程序属性
选择“生成”,勾选xml文档,这个xml里面会自动配置swagger
4.打开SwaggerNet.cs,屏蔽如下两行代码。
5.重新运行,看到下面页面则代表swagger配置成功。
四、编写接口及调试
1.新建测试model
代码如下:
2.新建一个测试controller
代码如下:
3.重新运行,看到新建的接口。
4.点击“TestAPI”,再点击“api/TestAPI”可打开接口详细内容。
5.接口测试。得到后台返回响应,则接口陈宫
五、注意说明
接口地址为http://localhost:64530/api/TestAPI
可利用Postman做测试
Copyright © 广州京杭网络科技有限公司 2005-2024 版权所有 粤ICP备16019765号
广州京杭网络科技有限公司 版权所有