记Asp.Net Core Swagger使用并带域接口处理的方法

 更新时间:2019-04-17 21:42:55   作者:佚名   我要评论(0)

引用作者原话:Asp.Net的WebApi中使用Swagger作为说明和测试的页面是非常不错的,比起WebApiTestClient来至少在界面上的很大的提升。但是使用Swagger时如果只

引用作者原话: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的注释,记得修改
      });

红色部分加入代码即可。

结果展示:

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

您可能感兴趣的文章:

  • .Net Core2.1 WebAPI新增Swagger插件详解
  • .NET Core利用swagger进行API接口文档管理的方法详解
  • Asp.net core WebApi 使用Swagger生成帮助页实例

相关文章

  • 记Asp.Net Core Swagger使用并带域接口处理的方法

    记Asp.Net Core Swagger使用并带域接口处理的方法

    引用作者原话:Asp.Net的WebApi中使用Swagger作为说明和测试的页面是非常不错的,比起WebApiTestClient来至少在界面上的很大的提升。但是使用Swagger时如果只
    2019-04-17
  • 正则表达式匹配路由的实现代码

    正则表达式匹配路由的实现代码

    在 web 开发中,可能会出现限制用户访问规则的场景,那么这个时候就需要用到正则匹配,根据自己的规则去限定请求参数再进行访问 具体实现步骤为: 导入转换
    2019-04-17
  • PHP PDO数据库操作预处理与注意事项

    PHP PDO数据库操作预处理与注意事项

    PDO(PHP Database Object)扩展为PHP访问数据库定义了一个轻量级的、一致性的接口,它提供了一个数据访问抽象层,这样,无论使用什么数据库,都可以通过一致
    2019-04-17
  • Laravel事件监听器用法实例分析

    Laravel事件监听器用法实例分析

    本文实例讲述了Laravel事件监听器用法。分享给大家供大家参考,具体如下: 这里讲述最佳实践方案,分以下步骤: 第一步:注册事件和监听器。 在EventServiceP
    2019-04-17
  • 浅谈正则速记法的技巧

    浅谈正则速记法的技巧

    给你一篇文章,如何挑选出你想要的字符串呢?你可以从左到右从上到下,一个一个字符读取出来,写一大堆if做判断。这样太麻烦了,正则就是将以上过程抽象出来,
    2019-04-17
  • PHP精确到毫秒秒杀倒计时实例详解

    PHP精确到毫秒秒杀倒计时实例详解

    精确到毫秒秒杀倒计时PHP源码实例,前台js活动展示倒计时,后台计算倒计时时间。每0.1秒定时刷新活动倒计时时间。 PHP: // 注意:php的时间是以秒算。
    2019-04-17
  • Asp.net core中实现自动更新的Option的方法示例

    Asp.net core中实现自动更新的Option的方法示例

    Asp.net core可以监视json、xml等配置文件的变化, 自动刷新内存中的配置内容, 但如果想每隔1秒从zookeeper、consul获取最新的配置信息, 需要自己实现. 阅读了
    2019-04-17
  • JS 正则表达式从地址中提取省市县

    JS 正则表达式从地址中提取省市县

    直接上代码,一看就懂, 一般国内地址返回Array前三项就是省市县,若要扩展到社区、街道等可自行扩展。 var add1 = '四川省成都市都江堰市天马镇34号';
    2019-04-17
  • Laravel框架实现的使用smtp发送邮件功能示例

    Laravel框架实现的使用smtp发送邮件功能示例

    本文实例讲述了Laravel框架实现的使用smtp发送邮件功能。分享给大家供大家参考,具体如下: 1、.env文件中配置 MAIL_DRIVER=smtp MAIL_HOST=smtp.邮箱后缀
    2019-04-17
  • 解决正则表达式\w和\d的疑惑

    解决正则表达式\w和\d的疑惑

    <&#63;php $string='April15,2003'; $pattern='/(\w+)(\d+),(\d+)/i'; $replacement='${1},${3}'; echo preg_replace($pattern,$replacement,$string); &#6
    2019-04-17

最新评论