VB.NET ASP.NET WebAPI及应用(番外篇)Swagger接口文档自动生成

2021-12-31 15:24:28 浏览数 (1)

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的配置文件里面即可!!!

代码语言：javascript复制
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按钮出现一下页面说明成功

好了今天的内容就介绍到这里了

代码语言：javascript复制
实例下载

链接：https://pan.baidu.com/s/1NzdnMTNKK-y5WqzcvVhB-A 
提取码：vbee
c# java .net vbscript asp.net

0 人点赞