swagger传复杂参数

发布网友发布时间：2022-05-05 05:04

共1个回答

热心网友时间：2023-10-10 11:22

1、常用参数

a、配置参数

.groupName("商品接口文档") 设置栏目名

.select() 初始化并返回一个API选择构造器

.paths(PathSelectors.any()) 设置路径筛选

.apis(RequestHandlerSelectors.basePackage("com.mao.swagger.goods.controller")) 添加路径选择条件

.build(); 构建

PathSelectors类的方法：

Predicate<String> any():满足条件的路径，该断言总为true

Predicate<String> none():不满足条件的路径,该断言总为false (生产环境可以屏蔽掉swagger：https://blog.csdn.net/goldenfish1919/article/details/78280051)

Predicate<String> regex(final String pathRegex):符合正则的路径

RequestHandlerSelectors类的方法：

Predicate<RequestHandler> any()：返回包含所有满足条件的请求处理器的断言，该断言总为true

Predicate<RequestHandler> none()：返回不满足条件的请求处理器的断言,该断言总为false

Predicate<RequestHandler> basePackage(final String basePackage)：返回一个断言(Predicate)，该断言包含所有匹配basePackage下所有类的请求路径的请求处理器

b、接口参数

@Api()用于类；表示标识这个类是swagger的资源【参考code1，效果图1】

@ApiOperation()用于方法；表示一个http请求的操作【参考code1，效果图1】

@ApiParam()用于方法，参数，字段说明；表示对参数的添加元数据（说明或是否必填等）【暂时没用，当前使用SpringMVC@RequestParam】

@ApiModel()用于类表示对类进行说明，用于参数用实体类接收【参考code2，效果图2，3】

@ApiModelProperty()用于方法，字段表示对model属性的说明或者数据操作更改【参考code2，效果图2，3】

@ApiIgnore()用于类，方法，方法参数表示这个方法或者类被忽略【参考code1，效果图1】

@ApiImplicitParam() 用于方法表示单独的请求参数【参考code1，效果图1】

@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam 【参考code1，效果图1】

code1

请点击输入图片描述

效果图1

请点击输入图片描述

code2

请点击输入图片描述

效果图2

请点击输入图片描述

效果图3