swagger上传文件并支持jwt认证的实现方法

程序员文章站 2023-02-21 16:09:55

什么是 swagger? swagger的目标是为rest apis 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量...

什么是 swagger?

swagger的目标是为rest apis 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，swagger去掉了调用服务时的很多猜测。

背景

　　由于swagger不仅提供了自动实现接口文档的说明而且支持页面调试，告别postman等工具，无需开发人员手动写api文档，缩减开发成本得到大家广泛认可但是由于swagger没有提供上传文件的支持，所以只能靠开发人员自己实现。今天就来看看如何扩展swagger达到上传文件的需求

动起小手手

1安装swagger

nuget安装swashbuckle.aspnetcore.swagger组件

2设置生成xml

右键项目>属性>生成

swagger上传文件并支持jwt认证的实现方法

相应的把其他需要生成文档说明的项目也按上步骤进行设置xml

关键swagger代码

using microsoft.aspnetcore.builder;
using microsoft.extensions.configuration;
using microsoft.extensions.dependencyinjection;
using microsoft.extensions.platformabstractions;
using swashbuckle.aspnetcore.swagger;
using system;
using system.collections.generic;
using system.io;
using system.linq;
using system.threading.tasks;
namespace chaunce.api.app_start
{
 /// <summary>
 /// swaggerconfig
 /// </summary>
 public class swaggerconfig
 {
  /// <summary>
  /// initswagger
  /// </summary>
  /// <param name="services"></param>
  public static void initswagger(iservicecollection services)
  {
   services.addswaggergen(c =>
   {
    c.operationfilter<swaggerfileuploadfilter>();//增加文件过滤处理
    var security = new dictionary<string, ienumerable<string>> { { "bearer", new string[] { } }, };
    c.addsecurityrequirement(security);//添加一个必须的全局安全信息，和addsecuritydefinition方法指定的方案名称要一致，这里是bearer。
    var basepath = platformservices.default.application.applicationbasepath;// 获取到应用程序的根路径
    var xmlapipath = path.combine(basepath, "chaunce.api.xml");//api文件xml(在以上步骤2设置生成xml的路径)
    var xmlmodelpath = path.combine(basepath, "chaunce.viewmodels.xml");//请求modelxml
    c.includexmlcomments(xmlapipath);
    c.includexmlcomments(xmlmodelpath);
    c.swaggerdoc("v1", new info
    {
     title = "chaunce数据接口",
     version = "v1",
     description = "这是一个webapi接口文档说明",
     termsofservice = "none",
     contact = new contact { name = "chaunce官网", email = "info@chaunce.com", url = "http://blog.chaunce.top/" },
     license = new license
     {
      name = "swagger官网",
      url = "http://swagger.io/",
     }
    });
    c.ignoreobsoleteactions();
    c.addsecuritydefinition("bearer", new apikeyscheme
    {
     description = "权限认证(数据将在请求头中进行传输) 参数结构: \"authorization: bearer {token}\"",
     name = "authorization",//jwt默认的参数名称
     in = "header",//jwt默认存放authorization信息的位置(请求头中)
     type = "apikey"
    });//authorization的设置
   });
  }
  /// <summary>
  /// configureswagger
  /// </summary>
  /// <param name="app"></param>
  public static void configureswagger(iapplicationbuilder app)
  {
   app.useswagger();
   // enable middleware to serve swagger-ui (html, js, css, etc.), specifying the swagger json endpoint.
   app.useswagger(c =>
   {
    c.routetemplate = "docs/{documentname}/docs.json";//使中间件服务生成swagger作为json端点(此处设置是生成接口文档信息，可以理解为老技术中的webservice的soap协议的信息，暴露出接口信息的地方)
    c.preserializefilters.add((swaggerdoc, httpreq) => swaggerdoc.info.description = httpreq.path);//请求过滤处理
   });
   app.useswaggerui(c =>
   {
    c.routeprefix = "docs";//设置文档首页根路径
    c.swaggerendpoint("/docs/v1/docs.json", "v1");//此处配置要和useswagger的routetemplate匹配
    //c.swaggerendpoint("/swagger/v1/swagger.json", "v1");//默认终结点
    c.injectstylesheet("/swagger-ui/custom.css");//注入style文件
   });
  }
 }
}

swagger过滤器

using microsoft.aspnetcore.http;
using swashbuckle.aspnetcore.swagger;
using swashbuckle.aspnetcore.swaggergen;
using system;
using system.collections.generic;
using system.linq;
using system.threading.tasks;
namespace chaunce.api.help
{
 /// <summary>
 /// swagger文件过滤器
 /// </summary>
 public class swaggerfileuploadfilter : ioperationfilter
 {
  /// <summary>
  /// swagger过滤器（此处的apply会被swagger的每个接口都调用生成文档说明，所以在此处可以对每一个接口进行过滤操作）
  /// </summary>
  /// <param name="operation"></param>
  /// <param name="context"></param>
  public void apply(operation operation, operationfiltercontext context)
  {
   if (!context.apidescription.httpmethod.equals("post", stringcomparison.ordinalignorecase) &&
   !context.apidescription.httpmethod.equals("put", stringcomparison.ordinalignorecase))
   {
    return;
   }
   var apidescription = context.apidescription;
   var parameters = context.apidescription.parameterdescriptions.where(n => n.type == typeof(iformfilecollection) || n.type == typeof(iformfile)).tolist();//parameterdescriptions包含了每个接口所带所有参数信息
   if (parameters.count() <= 0)
   {
    return;
   }
   operation.consumes.add("multipart/form-data");
   foreach (var fileparameter in parameters)
   {
    var parameter = operation.parameters.single(n => n.name == fileparameter.name);
    operation.parameters.remove(parameter);
    operation.parameters.add(new nonbodyparameter
    {
     name = parameter.name,
     in = "formdata",
     description = parameter.description,
     required = parameter.required,
     type = "file",
     //collectionformat = "multi"
    });
   }
  }
 }
}

swagger上传文件并支持jwt认证的实现方法