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

 更新时间:2019年03月09日 16:36:18   作者:情·深  
这篇文章主要介绍了记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 = "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的注释,记得修改
      });

红色部分加入代码即可。

结果展示:

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

相关文章

  • ASP.NET防范SQL注入式攻击的方法

    ASP.NET防范SQL注入式攻击的方法

    所谓SQL注入式攻击,就是攻击者把SQL命令插入到Web表单的输入域或页面请求的查询字符串,欺骗服务器执行恶意的SQL命令,那么在ASP.NET中如何防范SQL注入式攻击,下文为大家揭晓
    2016-05-05
  • ASP.NET MVC5网站开发修改及删除文章(十)

    ASP.NET MVC5网站开发修改及删除文章(十)

    这篇文章主要为大家详细介绍了ASP.NET MVC5网站开发修改及删除文章,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2015-09-09
  • ASP.NET比较常用的26个性能优化技巧

    ASP.NET比较常用的26个性能优化技巧

    这篇文章主要给大家介绍asp.net中比较常用的26个性能优化技巧,主要设计到asp.net中常用的26个性能优化方面的内容,对于asp.net中常用的26个性能优化技巧感兴趣的朋友可以参考下本篇文章
    2015-10-10
  • VS2010、VS2008等项目的默认浏览器修改方法(图文)

    VS2010、VS2008等项目的默认浏览器修改方法(图文)

    默认情况下,VS会使用操作系统的默认浏览器,但我在调试 ASP.NET 程序时更偏向于使用IE浏览器,下面与大家分享下VS2010、VS2008等项目的默认浏览器的修改方法
    2013-05-05
  • WEB页面多语言支持解决方案

    WEB页面多语言支持解决方案

    WEB页面多语言支持解决方案...
    2006-09-09
  • Linq to SQL Delete时遇到问题的解决方法

    Linq to SQL Delete时遇到问题的解决方法

    在Linq to SQL中要删除一行记录,官方的例子教我这样做
    2008-03-03
  • ASP.NET C#生成下拉列表树实现代码

    ASP.NET C#生成下拉列表树实现代码

    下拉列表树很方便且时尚的一个导航,貌似很多的朋友都想实现这样一个列表树,本文将满足你们的设想,通过本文你们可以学到如何使用c#生成下拉列表树,感兴趣的你可不要错过了啊
    2013-02-02
  • ASP.NET MVC5网站开发之总体概述(一)

    ASP.NET MVC5网站开发之总体概述(一)

    这篇文章主要为大家详细介绍了ASP.NET MVC5网站开发之总体概述,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-08-08
  • 详解在Windows下如何使用AspNetCore Api 和consul

    详解在Windows下如何使用AspNetCore Api 和consul

    这篇文章主要介绍了详解在Windows下如何使用AspNetCore Api 和consul,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • asp.net操作ini文件示例

    asp.net操作ini文件示例

    这篇文章主要介绍了asp.net 操作INI文件的读写,读写操作本地ini配置文件的方法,需要的朋友可以参考下
    2014-02-02

最新评论