.NET Core WebAPI中使用swagger版本控制，添加注释

Tigers996

已于 2024-02-15 23:24:07 修改

阅读量1k

点赞数 8

分类专栏： .NET 文章标签： .netcore 中间件

于 2024-02-15 23:23:27 首次发布

本文链接：https://blog.csdn.net/d1332508051/article/details/136124603

版权

.NET 专栏收录该内容

15 篇文章 0 订阅

订阅专栏

本文介绍了如何在.NETCoreWebAPI项目中实现Swagger，通过添加注释生成API文档，并在Program中配置Swagger服务，包括设置标题、版本和描述，以及包含XML注释文件的方法。

摘要由CSDN通过智能技术生成

一、效果

版本注释

二、实现步骤

在代码中添加注释

在这里插入图片描述

在项目属性中生成API文档

在这里插入图片描述

在Program中注册Swagger服务并配置文档信息

在这里插入图片描述

// 添加swagger注释
builder.Services.AddSwaggerGen(x =>
{
    x.SwaggerDoc("v1", new OpenApiInfo { Title = "Swagger标题", Version = "第一版", Description = ".NET Core WebAPI中使用swagger版本控制，添加注释" });
    var curr = AppContext.BaseDirectory;
    x.IncludeXmlComments(curr + "/WebApplication1.xml", true);
 });