本文共 5920 字，大约阅读时间需要 19 分钟。
系列文章
在开始本篇正文之前，解决一个 @疯疯过 指出的错误，再次感谢指正。
步骤如下：
- 删掉
.Domain.Shared层中的项目引用，添加nuget依赖包Volo.Abp.Identity.Domain.Shared，可以使用命令：Install-Package Volo.Abp.Identity.Domain.Shared - 在
.Domain层中引用项目.Domain.Shared，在模块类中添加依赖typeof(MeowvBlogDomainSharedModule) - 将
.EntityFrameworkCore层中的引用项目.Domain.Shared改成.Domain。
上一篇文章()完成了对API返回模型的封装，紧接着我打算继续来折腾一下Swagger，之前的文章中已经简单用起了Swagger，本篇还是围绕它让其发挥更高的更多的价值。
当我们的项目不断壮大，API持续增多，这时如果想要快速准确定位到某个API可能不是那么容易，需要翻半天才能找对我们的API。于是对Swagger API文档分组和详细的文档描述就有必要了，就本项目而言，博客系统可以分组为：博客前台接口、博客后台接口、其它公共接口、JWT认证授权接口。
其中，博客后台组中的接口需要授权后才可以调用，需要授权那么就涉及到身份验证，在这里准备采用JWT(JSON WEB TOKEN)的方式进行。
分组
对Swagger进行分组很简单，在.Swagger层中的扩展方法AddSwagger(this IServiceCollection services)中多次调用options.SwaggerDoc(...)即可，像这样
... options.SwaggerDoc("v1", new OpenApiInfo { Version = "1.0.0", Title = "我的接口啊1", Description = "接口描述1" }); options.SwaggerDoc("v2", new OpenApiInfo { Version = "1.0.0", Title = "我的接口啊2", Description = "接口描述2" }); ...... 不过这样显得有点low，然后可以转变一下思路使用遍历的方式进行。options.SwaggerDoc(...)接收两个参数：string name, OpenApiInfo info。
name：可以理解为当前分组的前缀；OpenApiInfo：有许多可配置的参数，在这里我只用到三个，Version、Title、Description。
要注意，当在AddSwagger(...)中调用完后，还需要在我们的扩展方法UseSwaggerUI(this IApplicationBuilder app)中options.SwaggerEndpoint()使用它，同样的也用遍历的方法。它接收的的参数：string url, string name。
url：这里的url要与前面配置的name参数对应。
name：我们自定义显示的分组名称。
于是可以直接在扩展方法中新建一个内部类：SwaggerApiInfo
internal class SwaggerApiInfo { /// /// URL前缀 /// public string UrlPrefix { get; set; } /// /// 名称 /// public string Name { get; set; } /// /// public OpenApiInfo OpenApiInfo { get; set; } } 然后新建一个List<SwaggerApiInfo>手动为其初始化一些值。
... ////// Swagger分组信息，将进行遍历使用 /// private static readonly ListApiInfos = new List () { new SwaggerApiInfo { UrlPrefix = Grouping.GroupName_v1, Name = "博客前台接口", OpenApiInfo = new OpenApiInfo { Version = version, Title = "阿星Plus - 博客前台接口", Description = description } }, new SwaggerApiInfo { UrlPrefix = Grouping.GroupName_v2, Name = "博客后台接口", OpenApiInfo = new OpenApiInfo { Version = version, Title = "阿星Plus - 博客后台接口", Description = description } }, new SwaggerApiInfo { UrlPrefix = Grouping.GroupName_v3, Name = "通用公共接口", OpenApiInfo = new OpenApiInfo { Version = version, Title = "阿星Plus - 通用公共接口", Description = description } }, new SwaggerApiInfo { UrlPrefix = Grouping.GroupName_v4, Name = "JWT授权接口", OpenApiInfo = new OpenApiInfo { Version = version, Title = "阿星Plus - JWT授权接口", Description = description } } };...
version：我们将其配置在appsettings.json中，做到动态可以修改。
//AppSettings.cs... ////// ApiVersion /// public static string ApiVersion => _config["ApiVersion"];...//appsettings.json{... "ApiVersion": "1.0.0"...}
description：因为多次使用，就定义一个变量，内容自拟主要是一些介绍性的描述，将在Swagger界面进行显示。
UrlPrefix：分别为，v1,v2,v3,v4。在Domain.Shared层中为其定义好常量
//MeowvBlogConsts.cs... ////// 分组 /// public static class Grouping { ////// 博客前台接口组 /// public const string GroupName_v1 = "v1"; ////// 博客后台接口组 /// public const string GroupName_v2 = "v2"; ////// 其他通用接口组 /// public const string GroupName_v3 = "v3"; ////// JWT授权接口组 /// public const string GroupName_v4 = "v4"; }...
现在修改扩展方法AddSwagger(...)，遍历List<SwaggerApiInfo>。
... public static IServiceCollection AddSwagger(this IServiceCollection services) { return services.AddSwaggerGen(options => { //options.SwaggerDoc("v1", new OpenApiInfo //{ // Version = "1.0.0", // Title = "我的接口啊", // Description = "接口描述" //}); // 遍历并应用Swagger分组信息 ApiInfos.ForEach(x => { options.SwaggerDoc(x.UrlPrefix, x.OpenApiInfo); }); ... }); }... 在扩展方法UseSwaggerUI(...)使用，通用也需要遍历。
... // 遍历分组信息，生成Json ApiInfos.ForEach(x => { options.SwaggerEndpoint($"/swagger/{x.UrlPrefix}/swagger.json", x.Name); });... 细心的同学可以发现，我们前几篇文章打开Swagger文档的时候都是需要手动更改URL地址：.../swagger才能正确进入，其实Swagger是支持配置路由的。同时咱们也将页面Title也给改了吧。看下面UseSwaggerUI(...)完整代码：
... ////// UseSwaggerUI /// /// public static void UseSwaggerUI(this IApplicationBuilder app) { app.UseSwaggerUI(options => { // 遍历分组信息，生成Json ApiInfos.ForEach(x => { options.SwaggerEndpoint($"/swagger/{x.UrlPrefix}/swagger.json", x.Name); }); // 模型的默认扩展深度，设置为 -1 完全隐藏模型 options.DefaultModelsExpandDepth(-1); // API文档仅展开标记 options.DocExpansion(DocExpansion.List); // API前缀设置为空 options.RoutePrefix = string.Empty; // API页面Title options.DocumentTitle = "
转载地址：http://eduki.baihongyu.com/