20191205 swagger接口文档api完善

最新推荐文章于 2024-03-15 14:20:06 发布

原创最新推荐文章于 2024-03-15 14:20:06 发布 · 193 阅读

0 ·

CC 4.0 BY-SA版权

后端开发专栏收录该内容

118 篇文章

订阅专栏

本文介绍如何使用Swagger自定义Header参数，通过示例代码展示如何添加token信息到请求头，实现对框架的完善。并讨论了如何将这些功能封装成jar包供他人引用。

添加请求头，token信息，完善对框架的完善。自己打jar包让别人引用，慢慢进行封装。

 @Bean
    public Docket customDocket(){
    	ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();  
    	ticketPar.name("token").description("user token")
    	.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());
    }