.Net Core Swagger注释显示不全,我来帮你解决

前戏我就不做了,我喜欢直接点

我们知道swagger的注释依赖于xml,但有时候在发布后没xml,这不是难为我吗?我还得给前端一个字段一个字段解释,查资料后,找到解决方案

1.可能你查询的实体或者返回的实体不在webapi那个库,因此你需要你涉及到的实体库都开启生成xml文档
2.在你需要开启生成xml文件的类库的.csproj中加 GenerateDocumentationFile

<PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
  </PropertyGroup>

3.去starup.cs注入

services.AddSwaggerGen(c =>
{
   c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
   var xmlFile = AppContext.BaseDirectory;
   c.IncludeXmlComments(Path.Combine(xmlFile, "XXAPI.xml"));
   c.IncludeXmlComments(Path.Combine(xmlFile, "XXAPI.Models.xml"));
   c.IncludeXmlComments(Path.Combine(xmlFile, "XXAPI.Service.xml"));
});

运行完成

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值