• 三狮军团首秀 只有两千多球迷观战 2019-05-19
  • 人民网2017呼和浩特徒步迎新活动--内蒙古频道--人民网 2019-05-19
  • 【品牌资讯】环球网斩获“全国行业新闻网站传播力2017年6月榜”多项冠军 2019-05-15
  • 深化对经济工作主线的认识 从供需关系看供给侧结构性改革 2019-05-15
  • 格拉斯哥艺术学院起火 4年前曾遭火灾仍在整修 2019-05-14
  • 回复@地瓜干17世:猪临死才会嚎叫呢~ 2019-05-14
  • 婺源古村溪中发现鹰嘴龟 2019-05-08
  • 编辑评测:高夫净源控油平衡露 极速补水长效控油 2019-05-08
  • 四部门发文规范特色小镇建设防止“新瓶装旧酒” 2019-05-02
  • 【地球的盛会文明的聚会艺术的盛宴四海一家足球为人类和平幸福而荣耀!!!普京是当今人类世界最优秀的一代伟人俄罗斯赢啦!!!】 2019-04-29
  • 学习新思想,千万师生同上一堂课 2019-04-28
  • 你这种个体户都干不了的老蚕也配谈计划?真是笑死人不偿命哦? 2019-04-23
  • 感人!的哥带着患病父亲出车 孝心感动乘客 2019-04-23
  • 图解:习近平在纪念马克思诞辰200周年大会上讲话的16个金句 2019-04-16
  • 感触名家笔下的端午文化 吃香粽原来可以这样"文艺" 2019-04-16
  • 山西省十一选5遗漏:记Asp.Net Core Swagger使用并带域接口处理的方法

    山西体彩11选5直选遗漏 www.caxru.com  更新时间:2019年03月09日 16:36:19   作者:情·深   我要评论

    这篇文章主要介绍了记Asp.Net Core 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 = "[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的注释,记得修改
          });

    红色部分加入代码即可。

    结果展示:

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

    相关文章

    最新评论

  • 三狮军团首秀 只有两千多球迷观战 2019-05-19
  • 人民网2017呼和浩特徒步迎新活动--内蒙古频道--人民网 2019-05-19
  • 【品牌资讯】环球网斩获“全国行业新闻网站传播力2017年6月榜”多项冠军 2019-05-15
  • 深化对经济工作主线的认识 从供需关系看供给侧结构性改革 2019-05-15
  • 格拉斯哥艺术学院起火 4年前曾遭火灾仍在整修 2019-05-14
  • 回复@地瓜干17世:猪临死才会嚎叫呢~ 2019-05-14
  • 婺源古村溪中发现鹰嘴龟 2019-05-08
  • 编辑评测:高夫净源控油平衡露 极速补水长效控油 2019-05-08
  • 四部门发文规范特色小镇建设防止“新瓶装旧酒” 2019-05-02
  • 【地球的盛会文明的聚会艺术的盛宴四海一家足球为人类和平幸福而荣耀!!!普京是当今人类世界最优秀的一代伟人俄罗斯赢啦!!!】 2019-04-29
  • 学习新思想,千万师生同上一堂课 2019-04-28
  • 你这种个体户都干不了的老蚕也配谈计划?真是笑死人不偿命哦? 2019-04-23
  • 感人!的哥带着患病父亲出车 孝心感动乘客 2019-04-23
  • 图解:习近平在纪念马克思诞辰200周年大会上讲话的16个金句 2019-04-16
  • 感触名家笔下的端午文化 吃香粽原来可以这样"文艺" 2019-04-16
  • 吉林时时彩 香港六合彩现场开奖结果 福彩3d超级图表走势图 广东福彩官方微信 17063期胜负彩最新分析 浙江体彩6+1走势综合版 舟山飞鱼彩票开奖号码 p3试机号历史上的今天 秒速时时彩开奖平台 黑金快乐8登录网站 上海时时彩彩乐乐 福利彩票走势图双色球走势图 彩客网胜平负 麻将牌 无锡麻将 时时乐上海彩票控开奖