欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

发布.net core3.0 webapi +swagger

程序员文章站 2024-01-21 18:48:40
...

填坑。。。

今天弄了个.net core3.0 webapi +swagger的项目,想发布看下啥效果,就像平常发布项目一样。

发布运行之后发现我的xml注释全没了。这就奇怪了,本地运行是有的呢,经过一番查找发现要在项目的.csproj文件中加一段代码

<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

如果还是不行,看看发布的文件夹里面有没有xml,没有的话复制过去也能显示。

然后在用swagger过程中还遇到一个坑,比如我想让我的放回参数有注释,swagger里面注释都是通过xml读出来的,如果你使用的返回参数的类在同一个当前项目中,那就自然能显示,比如我现在的项目是Test.API,如果我的返回参数的类在这个项目里面,那自然会有注释,如果在别的类库中,那么就需要拿到类库的xml,先在属性中勾线xml文档文件,然后在Startup中把类库的xml也注册一下,这样的话注释就有了,这也不能算是个坑,只能说swagger的逻辑是这么处理的,理解了就好多了。

 i.IncludeXmlComments(xmlPathEntity);

 

相关标签: .Net Core