AspNetCoreWebApiSwagger配置
NuGet地址：https://www.nuget.org/packages
在NuGet中搜索 Swashbuckle.AspNetCore 找到 Swagger 包
在程序包管理器控制台中输入如下代码
?| 01 |
Install-Package Swashbuckle.AspNetCore -Version 5.3.3
|
在依赖项中出现 Swashbuckle.AspNetCore 表示添加成功
2、配置Swagger中间件 ?
| 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 |
public void ConfigureServices(IServiceCollection services)
{
// 注册Swagger服务
services.AddSwaggerGen(c =>
{
// 添加文档信息
c.SwaggerDoc("v1", new OpenApiInfo
{
Title = "TestWebApi",
Version = "v1",
Description = "测试API",
Contact = new OpenApiContact
{
Name = "Kebele8",
Email = "123456789@qq.com"
}
});
});
}
|
2.2、在 Startup 类的 Configure 方法中，启用中间件为生成的 JSON 文档和 Swagger UI 提供服务
3.1、使用XML注释
?
| 01 02 03 04 05 06 07 08 09 10 |
services.AddSwaggerGen(c =>
{
#region 读取xml信息
// 使用反射获取xml文件，并构造出文件的路径
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
// 启用xml注释，该方法第二个参数启用控制器的注释，默认为false.
c.IncludeXmlComments(xmlPath, true);
#endregion
});
|
3.3、配置启动地址
右键项目→调试，设置启动浏览器路径，复制 应用URL 到 启动浏览器路径
运行，效果图如下：
请求接口显示如下：
model也会显示在下方
End！