解决swagger跨项目或跨程序集注释不显示问题

当使用Swagger生成项目接口文档时,遇到接口参数注释不显示的问题。原因是Swagger仅加载当前项目注释文件,而非包含入参和出参实体的其他项目。解决方法包括在实体所在项目设置中勾选输出注释文件,并在Swagger配置中加载这些注释文件,通过指定代码实现跨项目注释的显示。
摘要由CSDN通过智能技术生成

背景

我们在使用Swagger生成.NET Core Web Api 项目接口文档时候,发现接口的入参出参的注释是看不见的,如下:

190828-swagger-no-summary.png

但是我想要结果是这样:

190828-swagger-summary.png

原因分析以及方案

为什么没有显示注释呢,注释确实写了呀?

190828-swagger-model.png

原因很简单,通常我们用Swagger的时候只加载当前项目生成的xml注释文件,例如这样:

var xmlPath = Path.Combine(basePath, "AppData", "XXX.WebAPI.xml");
services.AddSwaggerGen(c =>
{
    c.IncludeXmlComments(item);
}
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值