NetCore项目安装Swagger

云远12189

已于 2023-02-23 13:13:23 修改

阅读量194

点赞数

分类专栏： C# 文章标签：开发语言

于 2023-02-17 16:02:35 首次发布

本文链接：https://blog.csdn.net/weixin_41575632/article/details/129088732

版权

C# 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

NetCore项目安装Swagger

管理NuGet程序包
搜索swashbuckle
配置Program.cs文件

builder.Services.AddSwaggerGen();
builder.Services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new OpenApiInfo
    {
        Version = "v1",
        Title = "ToDo API",
        Description = "An ASP.NET Core Web API for managing ToDo items",
        TermsOfService = new Uri("https://example.com/terms"),
        Contact = new OpenApiContact
        {
            Name = "Example Contact",
            Url = new Uri("https://example.com/contact")
        },
        License = new OpenApiLicense
        {
            Name = "Example License",
            Url = new Uri("https://example.com/license")
        }
    });

    // using System.Reflection;
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename), true); //假如需要显示控制器注释，就添加true

    //参考地址，https://www.cnblogs.com/zxtceq/p/14119865.html  另外，文档也介绍了使用枚举
    // var xmlModelPath = Path.Combine(AppContext.BaseDirectory, "WebApi.Core.Models.xml");//这个就是Models层的xml文件名

    var ModelXmlFilename = $"Demo.Models.xml";
    //options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, ModelXmlFilename));
});


if (app.Environment.IsDevelopment()) //只有在开发环境才能看到Swagger,部署完成是看不到的
{
    app.UseSwagger();
    app.UseSwaggerUI(
        c =>
        {
            c.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
        }
   );
}