使用swagger遇到的问题

摘要:
UserName.name(“UserName”)。description(“用户名”)。defaultValue(“userName”)。modelRef(newModelRef(“string”))。parameterType(“header”)。必需(false)。build();

1.定义全局的请求参数时,

defaultValue不能是中文,不然一直是请求中

ParameterBuilder userName = new ParameterBuilder();
ParameterBuilder tokenPar1 = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
userName.name("userName").description("用户名").defaultValue("userName").modelRef(new ModelRef("string"))
        .parameterType("header").required(false).build();
tokenPar1.name("estateId").description("楼盘ID").defaultValue("estateId").modelRef(new ModelRef("string"))
        .parameterType("header").required(false).build();

pars.add(userName.build());
pars.add(tokenPar1.build());

Docket docket = new Docket(DocumentationType.SWAGGER_2).select()
        .apis(RequestHandlerSelectors.basePackage("com.zyh.learn.zyhlearn")).paths(PathSelectors.ant("/**"))
        .build().globalOperationParameters(pars).apiInfo(apiInfo);

2.有时候swagger找不到页面资源,需要自己定义资源指向

@Configuration
public class SwaggerWebMvcConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");

    }
}

3.swagger的notes里换行不是

     swagger-springmvc 换行使用 <br/>
    springfox-swagger2 换行使用 空格+空格+

4.含有@PathVariable的url传参

转载自https://www.cnblogs.com/alsodzy/p/9290836.html

@ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
    @ApiImplicitParam(paramType="path", name = "id", value = "用户ID", required = true, dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.GET)
    public User getUser(@PathVariable Long id) {
        return users.get(id);
    }

详细的注解说明

  • @Api:用在类上,说明该类的作用
  • @ApiOperation:用在方法上,说明方法的作用
  • @ApiImplicitParams:用在方法上包含一组参数说明
  • @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
    • paramType:参数放在哪个地方
      • header-->请求参数的获取:@RequestHeader
      • query-->请求参数的获取:@RequestParam
      • path(用于restful接口)-->请求参数的获取:@PathVariable
      • body(不常用)
      • form(不常用)
    • name:参数名
    • dataType:参数类型
    • required:参数是否必须传
    • value:参数的意思
    • defaultValue:参数的默认值
  • @ApiResponses:用于表示一组响应
  • @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
    • code:数字,例如400
    • message:信息,例如"请求参数没填好"
    • response:抛出异常的类
  • @ApiModel:描述一个Model的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
    • @ApiModelProperty:描述一个model的属性

免责声明:文章转载自《使用swagger遇到的问题》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇木马控制技术(二) -- 端口复用基于Flask的 api(三)下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

使用Roslyn脚本化C#代码,C#动态脚本实现方案

【前言】   Roslyn 是微软公司开源的 .NET 编译器。   编译器支持 C# 和 Visual Basic 代码编译,并提供丰富的代码分析 API。   Roslyn不仅仅可以直接编译输出,难能可贵的就是上述描述中的开放了编译的API,使得代码脚本化成为了可能。   关于Roslyn,本文不做过多介绍,因为再介绍的丰满终究不及官方文档介绍的细腻,...

WebApi如何传递参数

 一 概述 一般地,我们在研究一个问题时,常规的思路是为该问题建模;我们在研究相似问题时,常规思路是找出这些问题的共性和异性。基于该思路,我们如何研究WebApi参数传递问题呢? 首先,从参数本身来说,种类较为多(如int,double,float,string,array,Object等),且有些类型较为复杂(如值类型和引用类型的机制等); 其次,从基于...

HTTP协议---HTTP请求中的常用请求字段和HTTP的响应状态码及响应头

基本 HTTP 协议 打开浏览器,输入服务器 IP,例如 http://192.168.0.3,如果端口号不80,例如是 8000,则输入 http://192.168.0.3:8000 。这时浏览器向服务器发送的 HTTP 协议头如下: GET / HTTP/1.1 Host: 192.168.0.3:8000 User-Agent: Mozilla/5...

open-falcon监控系统

官方文档 https://book.open-falcon.org/zh/intro/index.html 一、Open-Falcon介绍 1、监控系统,可以从运营级别(基本配置即可),以及应用级别(二次开发,通过端口进行日志上报),对服务器、操作系统、中间件、应用进行全面的监控,及报警,对我们的系统正常运行的作用非常重要。 2、基础监控 CPU、Load...

js之Function原型

在ECMAScript中,Function(函数)类型实际上是对象。每个函数都是Function类型的实例,而且都与其他引用类型一样具有属性和方法。由于函数是对象,因此函数名实际上也是一个指向函数对象的指针。 1、三种函数声明的方式  1》第一种:普通方式声明函数 1 function box (num1,num2){ 2 return nu...

读书笔记:深入理解ES6(十)

第十章 改进的数组功能   ES6标准在ES5的基础上,继续改进数组,为数组添加了很多新功能。例如:创建数组的新方法、几个实用便捷的方法及创建定型数组(Typed Array)的能力。本章一一讲解这些新特性。 第1节 创建数组   1. 传统的创建数组的方法。   在ES6以前,创建数组的方式有两种:一种是调用Array构造函数,一种是使用数组自面量语法。...