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

什么是 Swagger?

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

背景

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

动起小手手

 1安装swagger

nuget安装Swashbuckle.AspNetCore.Swagger组件

2设置生成xml

右键项目>属性>生成

相应的把其他需要生成文档说明的项目也按上步骤进行设置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"
    });
   }
  }
 }
}

打开浏览器http://localhost:8532/docs/

还没有结束,我们看看如何让Jwt的认证信息自动存在请求头免去每次手动塞

点击

(实际情况是填写的信息格式是:Bearer *************(Bearer与后面信息有一个空格))

此时随意访问任何api,都会将以上信息自动塞入header中进行请求,如下验证

至此目的都达到了

参考:

http://www.jb51.net/article/140105.htm

https://github.com/domaindrivendev/Swashbuckle

总结

以上所述是小编给大家介绍的swagger上传文件并支持jwt认证的实现方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对我们网站的支持!

您可能感兴趣的文章:

  • SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)
  • Spring Boot集成springfox-swagger2构建restful API的方法教程
  • Spring MVC集成springfox-swagger2构建restful API的方法详解
  • Asp.net core WebApi 使用Swagger生成帮助页实例
(0)

相关推荐

  • Asp.net core WebApi 使用Swagger生成帮助页实例

    最近我们团队一直进行.net core的转型,web开发向着前后端分离的技术架构演进,我们后台主要是采用了asp.net core webapi来进行开发,开始每次调试以及与前端人员的沟通上都存在这效率低下的问题,一次在看微软asp.net core官方文档的时候,发现了swagger这个好东西.然后在实际的项目中引入了该技术.我们开发人员测试自己写的api的过程大大得到了简化,前端人员也可以根据我们提供的swagger help pages 自己进行一些前端代码的测试,大大提高了前后端的开发效

  • SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)

    pom.xml增加依赖包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <

  • Spring MVC集成springfox-swagger2构建restful API的方法详解

    前言 在集成springfox-swagger2之前,我也尝试着集成了swagger-springmvc,方式差不多,但是swagger-springmvc相对麻烦一点,因为要把它的静态文件copy到自己的项目中.所以还是用新版本的. 至于两者有什么不同,为什么进行版本变更请参见官方说明文档 方法如下 这里先写下需要的pom.xml配置(我引用的2.4.0,相对稳定) <dependency> <groupId>io.springfox</groupId> <ar

  • Spring Boot集成springfox-swagger2构建restful API的方法教程

    前言 之前跟大家分享了Spring MVC集成springfox-swagger2构建restful API,简单写了如何在springmvc中集成swagger2.这边记录下在springboot中如何集成swagger2.其实使用基本相同. 方法如下: 首先还是引用相关jar包.我使用的maven,在pom.xml中引用相关依赖(原来我使用的是2.2.0的,现在使用2.4.0的): <dependency> <groupId>io.springfox</groupId&g

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

    什么是 Swagger? Swagger的目标是为REST APIs 定义一个标准的,与语言无关的接口,使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能.当服务通过Swagger定义,消费者就能与远程的服务互动通过少量的实现逻辑.类似于低级编程接口,Swagger去掉了调用服务时的很多猜测. 背景 由于swagger不仅提供了自动实现接口文档的说明而且支持页面调试,告别postman等工具,无需开发人员手动写api文档,缩减开发成本得到大家广泛认可

  • 如何使用Swagger上传文件

    前言 随着前后端分离开发模式的普及,后端人员更多是编写服务端API接口.调用接口实现文件上传是一个常见的功能,同时也需要一个选择文件上传的界面,可以编写前端界面上传,可以使用Postman.curl来模拟上传请求.上述的方式多多少少有点麻烦.Swagger作为Api说明文档及调试工具,如果它能提供文件上传的界面(默认不提供),那会更加方便文件上传提示,本文将介绍如何使用Swagger来上传文件. 步骤 1. 安装Swagger Install-Package Swashbuckle.AspNet

  • layui 上传文件_批量导入数据UI的方法

    使用layui的文件上传组件,可以方便的弹出文件上传界面. 效果如下: 点击[批量导入]按钮调用js脚本importData(config)就可以实现数据上传到服务器. 脚本: /*** * 批量导入 * config.downUrl 下载模板url * config.uploadUrl 上传文件url * config.msg * config.done 上传结束后执行. */ function importData(config){ var default_config = { msg:"数

  • eWebEditor 上传文件提示格式不正确的解决方法

    原来是在系统上出了问题.是2003的IIS出现了问题,因为是2003的系统,它对ASP的上传文件做出了200K的限制,解决问题方法如下 : 先打开:Internet 信息服务(IIS)管理器 (本地计算机 )---- 属性 ----允许直接编辑配置数据库(N) 一定要勾先"允许直接编辑配置数据库(N)" 然后在 服务 里关闭iis admin service服务 找到windows\system32\inetsrv下的metabase.xml, 用计事本打开metabase.xml,找

  • 用批处理上传文件到ftp目录下的实现方法

    为了快速将项目中开发的补丁程序通过ftp快速上传到linux下,感觉每次用flashFxp等工具麻烦),写了个简单的批处理,与大家分享一下. 将以下代码保存为.bat格式的文件,每次将要上传的补丁保存在规定的本地目录中,只要双击执行此文件就能上传到你的指定目录上. 说明: 192.168.1.1 ftp ip 地址 21 端口 username 用户名 password 密码 temp.txt 保存ftp信息的临时文件,上传后删除 C:\Documents and Settings\user\桌

  • php上传文件并存储到mysql数据库的方法

    本文实例讲述了php上传文件并存储到mysql数据库的方法.分享给大家供大家参考.具体分析如下: 下面的代码分别用于创建mysql表和上传文件保存到mysql数据库 创建mysql表: <?php $con = mysql_connect("localhost", "", ""); mysql_select_db("w3m"); $sql = "CREATE TABLE updfiles (" . &

  • PHP上传文件及图片到七牛的方法

    上传文件到七牛最简单的方式就是使用七牛官方最新的SDK 安装PHP SDK composer require qiniu/php-sdk 上传文件到七牛 use Qiniu\Auth; use Qiniu\Storage\UploadManager; $cfg = [ 'access' => 'YOUR_ACCESS_KEY', 'secret' => 'YOUR_SECRET_KEY', 'bucket' => 'YOUR_BUCKET', 'domain' => 'https:

  • fckeditor上传文件按日期存放及重命名方法

    1. 实现 fckeditor 按日期分目录的形式存放上传的文件,比如今天是 2015年5月5日,那么今天上传的文件都放在这个目录里面去,明天上传的则自动创建并放在类似 2015-05-06 这样的目录里面去. (1)找到 editor\editor\filemanager\connectors\php\ 文件夹下的 config.php 文件 (2)找到如下配置变量 查看代码打印 复制代码 代码如下: $Config['UserFilesPath'] = '/uploadfiles/'; 将其

  • 使用Swagger直接上传文件的方法

    经常使用swagger,可以通过设置[ProducesResponseType]标记接口的返回信息:swagger也能通过接口的参数列表,自动获得发送的数据结构信息. 不过有一个例外,就是上传文件的时候,设置了[Consumes]的内容为multi-part/form-data,但是swagger并不能正常感知是上传文件的.代码是这个样子的: 关于文件上传的细节,可以看多年前我写过一篇有关通过WEBAPI上传文件的文章. [Consumes("multipart/form-data")

  • 基于django和dropzone.js实现上传文件

    1.dropzone.js http://www.dropzonejs.com/ dropzone.js是一个可预览\可定制化的文件拖拽上传,实现AJAX异步上传文件的工具 2.dropzone.js前端界面上传方式 官网下载 并且引入dropzone.js和dropzone.css(http://www.dropzonejs.com/)以及引用jquery.js,定义一个class="dropzone"即可完成, 代码示例: <!DOCTYPE html> <htm

随机推荐