Abp vNext swagger注释

网上看了一些Abp vNext引用swagger的教程，大致流程都差不多，就是生成每一层对应的xml然后使用IncludeXmlComments方法来引用，后面亲自实践发现有些差异和要点，在此记录一下。

基本步骤：

右击项目解决方案，属性-生成-输出-勾选XML文档文件，删除路径信息仅保留xml文件名称。例如：xxx.Application.xml。

hostmodule下，AddSwaggerGen内添加以下代码：

 1 context.Services.AddSwaggerGen(options=> {
 3     // 添加swagger-API方法注释
 4     var xmlapppath = Path.Combine(AppContext.BaseDirectory, "xxx.Application.xml");
 5     if (File.Exists(xmlapppath))
 6         options.IncludeXmlComments(xmlapppath, true);
 7
 8     // 添加swagger-DTO参数注释
 9     var xmlContractspath = Path.Combine(AppContext.BaseDirectory,"xxx.Application.Contracts.xml");
10     if (File.Exists(xmlContractspath))
11         options.IncludeXmlComments(xmlContractspath, true);
12
13     // 添加swagger-自定义控制器注释
14     var xmlapipath = Path.Combine(AppContext.BaseDirectory, "xxx.WebAPI.xml");
15     if (File.Exists(xmlapipath))
16         options.IncludeXmlComments(xmlapipath , true);
17 });

引用路径不要采用本地路径，可以使用AppContext.BaseDirectory来拼接地址以避免发布时遇到问题。
xxx.Application.xml添加引用后可以生成API方法注释，但是并没有DTO参数注释，因为dto定义都在应用服务抽象层，需要添加xxx.Application.Contracts.xml后才会有参数注释。
因为一般使用的是动态API，如果你有自定义的controller方法，需要添加xxx.HttpApi.xml进来才能看到自定义控制器方法的注释。
配置生成XML文件时，注意配置release环境下的输出，不要只配Debug模式。

Abp vNext swagger注释相关推荐

基于 abp vNext 和 .NET Core 开发博客项目 - 完善与美化，Swagger登场
基于 abp vNext 和 .NET Core 开发博客项目 - 完善与美化,Swagger登场转载于:https://github.com/Meowv/Blog.git 在程序员界,总有一批强迫 ...
abp vnext中swagger使用小结
文章目录介绍先决条件具体说明模块类添加 Swagger配置类 1.接口分组 2.接口注释 3.JWT认证的安全锁显示 4.枚举注释的显示总结介绍现在大多工作中用到的后端开发都是基于RES ...
基于 abp vNext 和 .NET Core 开发博客项目 - 再说Swagger，分组、描述、小绿锁
基于 abp vNext 和 .NET Core 开发博客项目 - 再说Swagger,分组.描述.小绿锁 https://github.com/Meowv/Blog 在开始本篇正文之前,解决一个 @ ...
Abp VNext 项目创建简介
文章目录简介项目创建关于 module 项目的简单说明简单优化项目 1.移动端项目删除 2.*.sln.DotSettings 3.*.HttpApi.Host 的调整 4.*.HttpApi ...
.NET 6 之 ABP vNext 初体验
马上国庆了,dotNative 预祝大家假期愉快,Happy National Day! 本文将介绍在 .net6 平台的 asp.net core webapi 框架中,如何使用 abp vnext ...
基于 abp vNext 和 .NET Core 开发博客项目 - 异常处理和日志记录
基于 abp vNext 和 .NET Core 开发博客项目 - 异常处理和日志记录转载于:https://github.com/Meowv/Blog 在开始之前,我们实现一个之前的遗留问题,这个 ...
基于 abp vNext 和 .NET Core 开发博客项目 - 用AutoMapper搞定对象映射
基于 abp vNext 和 .NET Core 开发博客项目 - 用AutoMapper搞定对象映射转载于:https://github.com/Meowv/Blog 本篇紧接着来玩一下AutoM ...
基于 abp vNext 和 .NET Core 开发博客项目 - 统一规范API，包装返回模型
基于 abp vNext 和 .NET Core 开发博客项目 - 统一规范API,包装返回模型转载于:https://github.com/Meowv/Blog 在实际开发过程中,每个公司可能不尽 ...
基于 abp vNext 和 .NET Core 开发博客项目 - 自定义仓储之增删改查
基于 abp vNext 和 .NET Core 开发博客项目 - 自定义仓储之增删改查转载于:https://github.com/Meowv/Blog 本篇说一下自定义仓储的实现方式,其实在ab ...
基于 abp vNext 和 .NET Core 开发博客项目 - 数据访问和代码优先
基于 abp vNext 和 .NET Core 开发博客项目 - 数据访问和代码优先转载于:https://github.com/Meowv/Blog 本篇主要使用Entity Framework ...

Abp vNext swagger注释

Abp vNext swagger注释相关推荐

最新文章

热门文章