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

相关推荐
无忧.芙桃26 分钟前
Linux系统编程(四):用户与权限管理
linux·运维·服务器
金銀銅鐵38 分钟前
带您看懂字节码指令(四):一条指令里有什么
java·jvm
最强小杰1 小时前
某 OpenAI 兼容网关上的 `kimi-k3.1-pro`:Cline、Zed 接入与 SSE 排错示例
java·服务器·网络·ai
Flynn Liang2 小时前
流量治理不是限流那么简单:I/O 密集型 Java 服务的 6 层防线
java·微服务·高并发·限流·熔断·系统稳定性·resilience4j
学长毕设2 小时前
基于SpringBoot智慧养老服务平台设计与实现-附源码
java·spring boot·后端
曹牧2 小时前
Java:“刷新雪崩”
java·开发语言
秋天的怀念_David2 小时前
算法一千零一夜 · 第三十三夜 · 跳表
java·程序人生·算法
一个游离的指针2 小时前
Vue2:vue-router
前端·javascript·vue.js
Forget the Dream4 小时前
Spring AI 2.0 系列(二):第一个 ChatClient——从注入到一次完整调用
java·人工智能·spring boot·ai·springai
火山引擎和TA的超级拍档们4 小时前
产品情报局 11 | AI 数据湖 LAS:打造大模型时代多模态数据底座
前端·后端