Asp.NetCoreSwagger如何使用并带域接口处理-创新互联

这篇文章主要介绍了Asp.Net Core Swagger如何使用并带域接口处理，具有一定借鉴价值，感兴趣的朋友可以参考下，希望大家阅读完这篇文章之后大有收获，下面让小编带着大家一起了解一下。

成都创新互联公司是一家专业提供赵县企业网站建设,专注与网站建设、做网站、H5页面制作、小程序制作等业务。10年已为赵县众多企业、政府机构等服务。创新互联专业网站建设公司优惠进行中。

Asp.Net的WebApi中使用Swagger作为说明和测试的页面是非常不错的，比起WebApiTestClient来至少在界面上的很大的提升。但是使用Swagger时如果只是一般的控制器直接放到Controller下就可以了，而如果因不同的业务需求而需要分类或者有同名的类名时时则没办法很好的处理。

因为业务需求需要创建域，但是Swagger并未将域添加到接口。所以需要加上以下操作才行。

安装Swagger方法：

为了大家多看微软官方文档、就直接引用Swagger安装及使用方法。以下是微软官方文档。

https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.1&tabs=visual-studio

增加域接口显示方法：

using Microsoft.AspNetCore.Mvc.ApiExplorer;
using System.Collections.Generic;
using System.Linq;
using System.Text.RegularExpressions;

namespace System.Web.Http.Description
{
  /// <summary>
  /// API描述器扩展
  /// </summary>
  public static class ApiDescriptionExtension
  {
    /// <summary>
    /// 获取区域名称
    /// </summary>
    /// <param name="description"></param>
    /// <returns></returns>
    public static List<string> GetAreaName(this ApiDescription description)
    {
      string areaName = description.ActionDescriptor.RouteValues["area"];
      string controlName = description.ActionDescriptor.RouteValues["controller"];
      List<string> areaList = new List<string>();
      areaList.Add(controlName);
      if (!string.IsNullOrEmpty(areaName))
      {
        description.RelativePath = $"{areaName}/{controlName}/{description.RelativePath}";
      } 
      return areaList;
    }
  }
}

通过接口描述扩展获取区域及相关信息进行改写扩展。

使用说明：

services.AddSwaggerGen(c =>
      {
        c.SwaggerDoc("v1", new Swashbuckle.AspNetCore.Swagger.Info
        {
          Version = "v1.0.0",
          Title = " API",
          Description = description,
          TermsOfService = "你的公司",
          Contact = new Swashbuckle.AspNetCore.Swagger.Contact { Name = "Blog.Core", Email = "Blog.Core@xxx.com", Url = "https://www.jianshu.com/u/94102b59cc2a" }
          
        });
        //使用域描述
        c.TagActionsBy(apiDesc => apiDesc.GetAreaName());

        var basePath = PlatformServices.Default.Application.ApplicationBasePath;
        var xmlPath = Path.Combine(basePath, xmlName);//这个就是刚刚配置的xml文件名
        c.IncludeXmlComments(xmlPath, true);//默认的第二个参数是false，这个是controller的注释，记得修改
      });

红色部分加入代码即可。

结果展示：

感谢你能够认真阅读完这篇文章，希望小编分享的“Asp.Net Core Swagger如何使用并带域接口处理”这篇文章对大家有帮助，同时也希望大家多多支持创新互联网站建设公司，，关注创新互联行业资讯频道，更多相关知识等着你来学习!

网页名称：Asp.NetCoreSwagger如何使用并带域接口处理-创新互联
浏览地址：https://www.cdcxhl.com/article10/ccgpgo.html

成都网站建设公司_创新互联，为您提供自适应网站、服务器托管、网站导航、网站制作、全网营销推广、网站内链

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联