VB.NET ASP.NET WebAPI及应用(番外篇)Swagger接口文档自动生成
2023-04-18 16:54:24 时间
WebAPI应用集合列表
- VB.NET 创建ASP.NET WebAPI及应用(一)
- VB.NET 创ASP.NET WebAPI及应用(二) IIS和MYSQL安装
- VB.NET ASP.NET WebAPI及应用(三)使用Mysql数据库简单的用户登录注册取数据WebAPI
- VB.NET ASP.NET WebAPI及应用(四)[完结] 部署与客户端连接
还在为写接口文档而烦恼吗?不妨试试Swagger自动文档生成器,还可以在上面直接调试接口哦!!
整体效果
请求效果:
正题:
一,新建一个WebAPI应用(不会的认真看,前面文章有说,会的跳过)
二,开始正题,创建WebAPI应用成功后,打开VS;工具->NuGet 包管理程器->管理解决方案的NuGet程序包
三,在浏览的搜索框里面 搜索Swagger关键字,找到Swashbuckle的程序包或者直接搜索Swashbuckle,然后点击安装
四,安装成功后会在 App_Start 文件夹下多出一个SwaggerConfig.cs的C#配置文件
五,我们只要把SwaggerConfig.cs里面的代码清空,并把SwaggerConfig.cs文件改名为SwaggerConfig.vb的VB.NET文件
六,把以下VB.NET的配置文件,粘贴到SwaggerConfig.vb的配置文件里面即可!!!
Imports System.Web.Http
Imports Swashbuckle.Application
<Assembly: PreApplicationStartMethod(GetType(SwaggerConfig), "Register")>
Public Class SwaggerConfig
Public Shared Sub Register()
Dim thisAssembly = GetType(SwaggerConfig).Assembly
GlobalConfiguration.Configuration.EnableSwagger(Function(c) c.SingleApiVersion("v1", "Yourwebapiname")).EnableSwaggerUi()
End Sub
End Class
七,在Controllers控制器目录下明天加一个默认HomeController控制器
八,然后点击运行项目,出现403错误不用管他(因为没有默认指定控制器),我们直接在地址后面添加/api/home 访问我们创建的home控制器即可
8.1.出现以下页面说明成功访问home控制器Swagger UI
九.接下来测试一下Swagger是否已经自动生成WebAPI文档,我们只需要在地址后面添加http://localhost:62063/swagger/ui/index 即可访问,出现以下页面说明自动文档搭建成功
十,我们测试一下文档请求 点击try it out按钮出现一下页面说明成功
好了今天的内容就介绍到这里了
实例下载
链接:https://pan.baidu.com/s/1NzdnMTNKK-y5WqzcvVhB-A
提取码:vbee
相关文章
- 一个Java程序员对2011年的回顾
- 大数据发展历程
- Android高级进阶之路【一】Android中View绘制流程浅析
- 可信服务管理(Trusted Service Manager)介绍
- GIS应用|快速开发REST空间分析服务
- 未来十年微软长盛不衰的两项战略
- 领域驱动设计模式的收益与挑战
- cocos 3.0 一键打包android平台应该注意的细节
- 数智化时代,驱动企业转型升级的“三驾马车”是什么?
- 基于MINA构建高性能的NIO应用
- 使用Rainbond实现离线环境软件交付
- 工作流引擎 jBPM 5.2 发布
- 微信小程序Minium自动化测试(三)
- 桌面应用抢先体验,这次有点料!
- 甲骨文Java专利遭拒 起诉Android侵权受挫
- 云计算的应用领域及发展前景
- Java效率真的很低吗?Android为何要采用?
- Android高级进阶之路【二】十分钟彻底弄明白 View 事件分发机制
- 庖丁解牛之-Android平台RTSP|RTMP播放器设计
- 手机直付,超级方便