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框架网 - 开发框架文库

相关推荐
Lefan4 分钟前
一文了解什么是Dart
前端·flutter·dart
Patrick_Wilson9 分钟前
青苔漫染待客迟
前端·设计模式·架构
sleepcattt9 分钟前
Spring中Bean的实例化(xml)
xml·java·spring
lzzy_lx_208927 分钟前
Spring Boot登录认证实现学习心得:从皮肤信息系统项目中学到的经验
java·spring boot·后端
Dcs28 分钟前
立即卸载这些插件,别让它们偷你的资产!
java
写不出来就跑路30 分钟前
基于 Vue 3 的智能聊天界面实现:从 UI 到流式响应全解析
前端·vue.js·ui
OpenTiny社区33 分钟前
盘点字体性能优化方案
前端·javascript
神的孩子都在歌唱36 分钟前
常见的网络攻击方式及防御措施
运维·服务器·网络
FogLetter37 分钟前
深入浅出React Hooks:useEffect那些事儿
前端·javascript
Savior`L37 分钟前
CSS知识复习4
前端·css