java swagger ui 添加header请求头参数的方法

  • 更新时间:2022-06-11 11:54:03
  • 编辑:傅康健
本站收集了一篇java相关的编程文章,网友寇烨然根据主题投稿了本篇教程内容,涉及到java、swagger、header相关内容,已被933网友关注,下面的电子资料对本篇知识点有更加详尽的解释。
《算法设计、分析与实现从入门到精通:C、C++和Java》源代码
《算法设计、分析与实现从入门到精通:C、C++和Java》源代码
  • 大小:3.06 MB
  • 发布人:束晨星
  • 下载:算法设计

我用到的swagger 主要有三款产品,swagger editor,swagger ui 和swagger codegen。

swagger editor:主要是一个本地客户端,用来自己添加api,自己来测试,相当于一个api的可视化测试工具和定义工具吧。

swagger ui:主要用户嵌入到项目中,将所有的接口生成一个可视化的页面,方便前后端联调

swagger codegen:主要用于通过swagger来自动生成代码

我用的swagger ui主要在java项目中。将所有的http接口提供一个可视化页面。供前端同学看到,联调非常方便,所有的接口一目了然。

但是在使用swagger ui的时候,我有一个新的需求,就是我所有的接口都必须授权才能访问,即每个接口都必须添加一个header里的参数。一般用Authorization,但是我的键是ticket。于是尝试配置swagger,将每个接口都默认增加一个ticket的请求参数。

我在Java中用的swagger框架是springfox。springfox是比较新的,官方也一直在更新。java添加swagger我就不详细介绍了,这里只介绍如何在所有的swagger接口中默认都添加header参数

粘贴springfox配置如下:

package cn.ce.platform_service.interceptors;
 
import java.util.ArrayList;
import java.util.List;
 
import org.springframework.context.annotation.Bean;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
/**
* @Description : swagger配置配置
* @Author : Mars
* @Date : 2017年9月6日
*/
@WebAppConfiguration
@EnableSwagger2
@EnableWebMvc
//@ComponentScan(basePackageClasses = {ApisController.class }) //Instructs spring where to scan for API controllers
public class SwaggerConfig {
	
  /**
   * Every Docket bean is picked up by the swagger-mvc framework - allowing for multiple
   * swagger groups i.e. same code base multiple swagger resource listings.
   */
  @Bean
  public Docket customDocket(){
  	ParameterBuilder ticketPar = new ParameterBuilder();
    List<Parameter> pars = new ArrayList<Parameter>(); 
  	ticketPar.name("ticket").description("user ticket")
  	.modelRef(new ModelRef("string")).parameterType("header") 
  	.required(false).build(); //header中的ticket参数非必填,传空也可以
  	pars.add(ticketPar.build());  //根据每个方法名也知道当前方法在设置什么参数
 
    return new Docket(DocumentationType.SWAGGER_2)
    		.select()
    		.apis(RequestHandlerSelectors.any()) 
        .build() 
        .globalOperationParameters(pars) 
        .apiInfo(apiInfo());
  }
  
  ApiInfo apiInfo() { 
  	return new ApiInfoBuilder() 
      .title("api swagger document") 
      .description("前后端联调swagger api 文档") 
      .version("2.1.5.5") 
      .build();
  } 
}

修改swagger的配置文件如上即能满足swagger中所有的接口默认都加上ticket参数,非必填如下图:

java swagger ui 添加header请求头参数的方法

以上这篇java swagger ui 添加header请求头参数的方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持java学习网。

相关下载

  • 阿里Java开发手册

    大小:1.15 MB
  • Java 语言程序设计(第二版)

    大小:3.75 MB
  • Java设计模式深入研究

    大小:49.2 MB
  • Java完全参考手册(第8版)

    大小:129.87MB

相关教程

  • Java中方法名称和泛型相同的用法示例

    为网友们分享了关于Java的教程,这篇文章主要介绍了Java中方法名称和泛型相同的用法,结合实例形式分析了泛型替代方法名称的相关使用技巧,需要的朋友可以参考下

    发布时间:2022-06-11主题:

    查看详情
  • Java序列化常见实现方法代码实例

    给网友朋友们带来一篇关于Java的教程,这篇文章主要介绍了Java序列化常见实现方法代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

    发布时间:2022-06-10主题:Java序列化

    查看详情
  • 一起来了解Java的策略模式

    一起来了解Java的策略模式

    给大家整理了关于Java的教程,这篇文章主要为大家详细介绍了Java的策略模式,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助

    发布时间:2022-06-10主题:Java策略模式

    查看详情
  • Hibernate传入Java对象创建动态表并录入数据

    为网友们分享了关于java的教程,这篇文章主要介绍了Hibernate传入Java对象创建动态表并录入数据,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

    发布时间:2022-06-10主题:Hibernate传入Java对象

    查看详情
  • Java中的Random()函数及两种构造方法

    给大家整理一篇关于java的教程,Java中存在着两种Random函数分别是java.lang.Math.Random和java.util.Random,文中给大家介绍了random()的两种构造方法,感兴趣的朋友跟随小编一起看看吧

    发布时间:2022-06-10主题:

    查看详情
  • Java8 Collectors.toMap的坑

    给网友们整理关于java8的教程,这篇文章主要介绍了Java8 Collectors.toMap的坑,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

    发布时间:2022-06-11主题:Java8 Collectors.toMap

    查看详情
  • Java实现base64图片编码数据转换为本地图片的方法

    给网友们整理关于java的教程,这篇文章主要介绍了Java实现base64图片编码数据转换为本地图片的方法,涉及java编码转换及图片文件生成相关操作技巧,需要的朋友可以参考下

    发布时间:2022-06-10主题:

    查看详情

用户留言