• 在庆祝海南建省办经济特区30周年大会上的讲话 2019-10-07
  • 俄罗斯世界杯F组:球迷风采 2019-09-24
  • 彭于晏廖凡曝姜文“精神洁癖” 2019-09-24
  • 苏州大学研究生支教团网上众筹资助留守儿童 2019-09-23
  • 湖北政务微信排行榜第187期出炉 交警类公号表现亮眼 2019-09-19
  • 【奋斗吧2018】风电检修工——荒原上的“听风者” 2019-08-31
  • 母亲节又送康乃馨?送这样的健康佳品才走心 2019-08-30
  • [酷]此文已经把马克思理论、边际理论、人类需求层次理论、生物学理论、心理学理论、社会管理学理论等理论在哲学层面完美融合了! 2019-08-26
  • 兰芝雪纱修颜气垫隔离霜 2019-07-27
  • “鹊桥”中继星顺利进入使命轨道运行 2019-07-27
  • 超越舆情管理的360度信息决策 2019-07-22
  • 视频陶然居变形记:从路边小饭馆到全国餐饮十强 2019-07-21
  • 防震减灾事业发展的重要理论成果 2019-07-20
  • 珠宝配美人!李冰冰大片衣着性感秀身段 2019-07-20
  • 机器人也能拥有“情商”?这个可以有 2019-07-19
  • 香港赛马会论坛论坛:记Asp.Net Core Swagger使用并带域接口处理的方法

     更新时间:2019年03月09日 16:36:19   作者:情·深   我要评论
    这篇文章主要介绍了记Asp.Net Core Swagger使用并带域接口处理的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

    香港赛马会网站惠泽社绝杀八码 www.mwcrz.tw 引用作者原话: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 = "[email protected]", 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的注释,记得修改
          });

    红色部分加入代码即可。

    结果展示:

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

    相关文章

    最新评论

  • 在庆祝海南建省办经济特区30周年大会上的讲话 2019-10-07
  • 俄罗斯世界杯F组:球迷风采 2019-09-24
  • 彭于晏廖凡曝姜文“精神洁癖” 2019-09-24
  • 苏州大学研究生支教团网上众筹资助留守儿童 2019-09-23
  • 湖北政务微信排行榜第187期出炉 交警类公号表现亮眼 2019-09-19
  • 【奋斗吧2018】风电检修工——荒原上的“听风者” 2019-08-31
  • 母亲节又送康乃馨?送这样的健康佳品才走心 2019-08-30
  • [酷]此文已经把马克思理论、边际理论、人类需求层次理论、生物学理论、心理学理论、社会管理学理论等理论在哲学层面完美融合了! 2019-08-26
  • 兰芝雪纱修颜气垫隔离霜 2019-07-27
  • “鹊桥”中继星顺利进入使命轨道运行 2019-07-27
  • 超越舆情管理的360度信息决策 2019-07-22
  • 视频陶然居变形记:从路边小饭馆到全国餐饮十强 2019-07-21
  • 防震减灾事业发展的重要理论成果 2019-07-20
  • 珠宝配美人!李冰冰大片衣着性感秀身段 2019-07-20
  • 机器人也能拥有“情商”?这个可以有 2019-07-19
  • mg4377登录地址 竞彩篮球稳赚 百人棋牌aaa 赛车pk10技巧规律 大发快三大小单双稳赚买法 时时彩后三杀一码方法 三张牌游戏大厅 北京pk10预测 广州体彩快中彩 打鱼找漏洞赚一千多万