• 贵州省社科规划办与贵州日报社合作推出“文化贵州”专栏 2019-03-20
  • 就算不为了世界杯,俄罗斯也有那么多时髦好去处值得你飞去 2019-03-20
  • 山东十一选五走势图:记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-03-20
  • 就算不为了世界杯,俄罗斯也有那么多时髦好去处值得你飞去 2019-03-20