.net core webapi 配置swagger调试界面

时间:2024-11-26 00:05:19

一、创建一个.net core webapi的项目;

二、在nuget程序包管理器控制台输入  Install-Package Swashbuckle -version 6.0.0-beta902  ;

三、在Startup.cs文件中如下配置:

.net core webapi 配置swagger调试界面

注意:在.net core 2.0 中可以使用PlatformServices.Default.Application.ApplicationBasePath,在2.1版本中需要替换为AppDomain.CurrentDomain.BaseDirectory。

四、在webapi项目的属性中,将xml文档文件勾上,如下:

.net core webapi 配置swagger调试界面

五、更改启动路径:

更改启动路径有几种方式,现介绍两种方式。

第一种:在webapi项目的Properties/launchSettings.json文件中更改launchUrl参数值为swagger/ui,如下所示:

.net core webapi 配置swagger调试界面.net core webapi 配置swagger调试界面

第二种:

1、在Startup的Configure方法中定义默认路由:

.net core webapi 配置swagger调试界面

2、新建一个HomeController控制器,在其Index方法中进行重定向:

.net core webapi 配置swagger调试界面

六、生成项目,则网页自动跳转到swagger ui界面,如下所示:

.net core webapi 配置swagger调试界面