.NET Core Web API 项目与 Swagger 集成

183 阅读1分钟

前言

.NET Core Web API项目与Swagger集成,有些时候项目不带有Swagger,我们需要手动去配置,方法如下。

1. 创建API项目 已有可跳过

1.1 打开VS >> 创建新项目 >> 选择ASP.NET Core Web API项目 >> 下一步

image.png

1.2 输入项目名称 >> 选择项目存储位置 >> 下一步

image.png

1.3 选择框架版本(示例:5.0) >> 勾选/取消配置 >> 创建

image.png

2. 安装NuGet包

2.1 右击项目 >> 选择管理NuGet程序包

image.png

2.2 选择浏览 >> 搜索Swashbuckle.AspNetCore >> 选择包版本(示例:5.6.3) >> 点击安装 >> 接受许可证 >> 等待安装完成

image.png

3. 配置Swagger

3.1 进入Startup.cs文件,在ConfigureServices方法内添加以下代码并用项目名称替换{Project name}

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "{Project name}", Version = "v1" });
});

image.png

3.2 添加后会看到OpenApiInfo报错,这时将鼠标放置其上,Alt+Enter打开引用,引用命名空间即可。

image.png

3.3 接下来在Configure方法内添加以下代码并保存文件,同样替换{Project name}

app.UseSwagger().UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "{Project name} v1"));

image.png

4. 设置初始打开页面

4.1 进入Properties文件夹 >> launchSettings.json文件,修改两处LaunchUrl参数值并保存文件,如图所示:

"launchUrl": "swagger/index.html",
"launchUrl": "swagger",

image.png

4.2 Ctrl+F5运行项目,你可以看到默认打开swagger/index.html页面,这时表示集成成功。

image.png