北京快三单双:记Asp.Net Core Swagger使用并带域接口处理的方法

北京快三走势图 www.mxld9.cn  更新时间: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的注释,记得修改
      });

红色部分加入代码即可。

结果展示:

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

相关文章

最新评论

  • 星战外传再起——关于《游侠索罗》你应该知道的N件事 2019-05-26
  • “威马逊”在海南翁田镇沿海登陆 最大风力达17级 2019-05-25
  • 新版外商投资负面清单即将发布 2019-05-24
  • 解说米勒谈WE:LPL夏季赛夺冠可能性不大 2019-05-23
  • 陈坤:虽然会被困扰,但感谢情绪无法删除 2019-05-22
  • 问题来了!那些年你遇到的噪声扰民怎么办? 2019-05-21
  • 俞正声:广泛开展对外友好交往 2019-05-21
  • 运用互联网思维介入城市化会如何? 2019-05-20
  • 【加拿大房产网加拿大新房加拿大房产信息网】 2019-05-20
  • 银保监会新规剑指大企业多头融资和过度融资 2019-05-19
  • [网连中国]5地社保费率降低后工资条看变化 职工:只少交几块钱 2019-05-19
  • 全国政协委员侯一筠:发挥山东海洋优势,打造国家级科技成果转化平台 2019-05-18
  • 广西河池消防支队召开新兵第二阶段集训工作部署会 2019-05-18
  • 龙峰:帮助更多企业用好互联网—上游新闻对话重庆经济 2019-05-17
  • 其实,生产力发展了,社会财富丰富了,把小萌们养起来也不是什么问题……但你们不能被养着还养出脾气来还妄图对真正的劳动者指手画脚! 2019-05-16
  • 361| 417| 251| 289| 213| 870| 107| 670| 247| 522|