Swagger自动生成API接口注释和实体模型注释

Swagger生成API接口注释、实体模型注释

目录

前言

多位用户问我swagger注释生成的问题,这次写了篇最全面的分享给大家。

先看下swagger页面:

Swagger页面预览

控制器 api 接口注释

包括标题、内容、接口注释:

接口参数注释

模型的注释

解决方案

生成->输出->生成包含API文档的文件

WebApi Project项目右键属性,生成->输出->生成包含API文档的文件

重要:如果要生成实体模型的API文档文件,同样在实体模型Project项目右键属性,生成->输出->生成包含API文档的文件。

C#代码

C#

复制代码
builder.Services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new OpenApiInfo
    {
        Version = "v1",
        Title = "CSFramework.License",
        Description = "软件授权系统API接口文档 \r\nCopyrights@2024 www.csframework.com"
    });

    //控制器接口注释
    var xmlFileName = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlFilePath = Path.Combine(AppContext.BaseDirectory, xmlFileName);
    options.IncludeXmlComments(xmlFilePath, true);

    //实体注释
    var xmlModelFileName = $"{Assembly.Load("CSFramework.LicenseServerCore").GetName().Name}.xml";
    var xmlModelFilePath = Path.Combine(AppContext.BaseDirectory, xmlModelFileName);
    options.IncludeXmlComments(xmlModelFilePath, true);
});

专注.NET技术、C/S架构开发框架软件

C/S框架网 - 开发框架文库

相关推荐
社恐的下水道蟑螂3 分钟前
用CSS3拍一部《星球大战》片头?前端导演的"原力"修炼指南
前端·javascript
ᐇ9593 分钟前
Java 程序运行原理与内存模型解析
java·开发语言
sp426 分钟前
试探构建一个简洁、清晰的 Java 日期 API
java·后端
子非鱼3737 分钟前
git 常用命令行
前端
Tzarevich9 分钟前
CSS3星球大战:前端代码界的视觉导演艺术
前端·css
BBB努力学习程序设计10 分钟前
CSS复合选择器
前端·html
我爱钱因此会努力10 分钟前
shell实战-跳板机和测试主机是否在线
服务器·tcp/ip·bash
stu_kk14 分钟前
泛微Ecology9实现流程界面隐藏按钮
java·oa
czhc114007566314 分钟前
JAVA1027抽象类;抽象类继承
android·java·开发语言
练习时长一年22 分钟前
jdk动态代理的实现原理
java·开发语言