在ASP。网核心网络应用编程接口使用swag/OpenAPI(二)
实战
首先介绍三个重要组件：
Swashbuckle .AspNetCore。招摇：一个把SwaggerDocument对象暴露成数据端点(openapi.json对应的URI)的时髦的对象模型和中间件。
Swashbuckle .AspNetCore。SwaggerGen:一个根据路线（路由),控制器（控制器),模型（模型对象)生成SwaggerDocument的生成器，它通常与时髦的端点中间件相结合，自动公开Swagger JSON(openapi.json)。
Swashbuckle .AspNetCore。SwaggerUI:根据openapi.json生成的对应的用户界面界面
一、安装包
方式一：在与项目文件夹相同的目录下执行如下代码：
安装-包装Swashbuckle .AspNetCore-版本6.2.3
方式二：使用Nuget包管理工具：
添加并配置Swagger中间件
在Program.cs文件中把时髦的生成器添加到服务集合
//运行时调用此方法。使用此方法向容器添加服务。
公共void ConfigureServices(IServiceCollection服务)
{
服务AddControllers()；
//注册斯瓦格服务
span style=’ backgroundColo:yellow黄色黄海服务。addswaggerdocument()；/span
}
也在Program.cs启用生成数据文档和SwaggerUI的中间件
if (env .IsDevelopment())
{
div style=’背景colo :黄色’
//使中间件能够将生成的时髦的作为数据端点服务。
应用程序.useswaggle()；
//启用中间件服务网页界面等。),
//指定斯瓦格数据端点。
应用程序.UseSwaggerUI()；
/div
}
上面添加的两行代码只有在开发环境时才会生效，如果想在生产环境也使用霸气，就别放在上面的如果判断内
运行程序并访问https://localhost :端口/swag/v1/swag。数据就能看到openapi.json文档了港口。为自己电脑对应的端口比如（默认5000或5001)
通过https://本地主机：端口/swag路径访问SwaggerUI
如果想把SwaggerUI的路径设置成根路径(https://localhost:/)，把对应的RoutePrefix属性设为空字符串就行了
应用程序.UseSwaggerUI(选项=
{
选项SwaggerEndpoint(‘/swag/v1/swag。JSON ‘，’ v1 ‘)；
div style=’背景colo :黄色’
选项RoutePrefix=字符串。空的；
/div
});
}
如果使用了（同移民检查员移民检查)或者反向代理，用过添加。/前缀来时髦的端点使用相对地址，例如/赃物/v1/赃物。JSON，/swag/v1/swag。数据表示程序在统一资源定位器的真实跟目录下寻找数据文件，比如使用https://localhost :端口/路由_前缀/swag/v1/swag。数据而不是https://localhost :端口/virtual _ directory/route _ prefix/swag/v1/swag。JSON。
注意：
内容来源网络，如有侵权，联系删除，本文地址：https://www.230890.com/zhan/117952.html