ABP-------SwaggerUI 添加中文注释提示

最新推荐文章于 2023-06-28 15:56:56 发布

_IceInk

最新推荐文章于 2023-06-28 15:56:56 发布

阅读量1.5k

点赞数 2

分类专栏： ABP C# 文章标签： .net

本文链接：https://blog.csdn.net/weixin_42254467/article/details/108093205

版权

本文介绍了如何在ABP框架中为SwaggerUI接口添加中文注释提示。通过在应用程序项目设置生成XML文档，然后在Web主机项目的Startup.cs中配置SwaggerGen，可以将接口方法的注释显示在SwaggerUI界面上，方便接口使用。

摘要由CSDN通过智能技术生成

在使用ABP的时候，SwaggerUI接口默认是没有中文提示的，也就是只有接口名，没有显示对应的注释，现在我们就来给接口添加上对应的注释显示，方便提示别人使用，如下图：
ABP接口注释

1. 找到XXX.Application项目，右键–》属性–》生成，如下图：
勾选上XML文档文件，并记住XML文件名称。

2. 修改XXX.web.host项目里面的StartUp.cs脚本
在StartUp.cs中，找到方法ConfigureServices()，在services.AddSwaggerGen里面添加下面的脚本即可

  	//SwaggerUI 添加中文注释提示
	//将application层中的注释添加到SwaggerUI中，这样就会有中文提示，比较友好
    string baseDirect

关注

专栏目录