使用swagger遇到的问题

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里换行不是\n

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

 

 

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的属性