Swagger是一个非常方便的接口测试工具,只需要在写代码时写好注释,则可以自动通过注释,在生成接口的时候自动加上文档注释。
不过今天发现一个小bug:WebAPI项目A引用项目B时,无法生成B中的实体说明。
期望结果:在运行A的时候,能够查看B中实体的注释。
实际情况:结果Swagger生成的文档中,并没有包含B中的相关数据。
问题核心:
Swagger的文档,主要依赖于项目A生成的.xml文档,因为没有项目B的.xml文档,所以Swagger无法获取相关实体的说明信息。
解决办法:
1、为项目B配置,设置生成.xml文档。(选择项目,右键,属性,生成中可以设置xml的路径)
2、在项目A中增加使用B的.xml文档标注。
如:下图ZuFangSystem_API.xml是WebAPI项目A的文档,ZuFangSystem_DLL.xml是新增的项目B的文档。
网友评论