参数名参数值name参数名value参数的具体意义#xff0c;作用。

required参…

文章目录Swagger3常用配置注解接口测试API信息配置Swagger3

ApiImplicitParams,ApiImplicitParamSwagger3对参数的描述。

参数名参数值name参数名value参数的具体意义作用。

required参数是否必填。

dataType参数的数据类型。

paramType查询参数类型paramType有如下几种形式

类型作用path以地址的形式提交数据query直接跟参数完成自动映射赋值body以流的形式提交仅支持pos***ader参数在request

headers里边提交form以form表单的形式提交仅支持postApiResponses

参数名参数值code响应码400message信息例如请求参数类型错误。

response抛出异常的类。

Controller层

package

com.xct.swagger_1.controller.one;import

import

org.springframework.web.bind.annotation.*;/***

author

{ApiOperation(测试功能1)GetMapping(hello)public

String

HelloYc;}PostMapping(search)ApiImplicitParams({ApiImplicitParam(namename,value

姓名,requiredtrue,paramTypequery),ApiImplicitParam(name

age,value

Integer)})ApiOperation(测试查询)public

String

name:age;}ApiOperation(测试增加)PostMapping(add)public

String

user.getName():user.getAge();}GetMapping(user/{id})ApiOperation(根据id获取用户信息)ApiImplicitParams({ApiImplicitParam(name

id,value

path)})ApiResponses({ApiResponse(code500,message

后端代码错误),ApiResponse(code400,message

请求参数类型错误),ApiResponse(code404,message

请求路径错误)})public

com.xct.swagger_1.config;import

org.springframework.context.annotation.Bean;

import

org.springframework.context.annotation.Configuration;

import

springfox.documentation.builders.ApiInfoBuilder;

import

springfox.documentation.builders.RequestHandlerSelectors;

import

springfox.documentation.service.ApiInfo;

import

springfox.documentation.spi.DocumentationType;

import

springfox.documentation.spring.web.plugins.Docket;Configuration

//EnableSwagger2

Docket(DocumentationType.OAS_30)//

指定Swagger3.0版本.groupName(开发组001).select().apis(RequestHandlerSelectors.basePackage(com.xct.swagger_1.controller.one))//扫描指定包下的api.build().apiInfo(createApiInfo());}Beanpublic

Docket

Docket(DocumentationType.OAS_30)//

指定Swagger3.0版本.groupName(开发组002).select().apis(RequestHandlerSelectors.basePackage(com.xct.swagger_1.controller.two))//扫描指定包下的api.build().apiInfo(createApiInfo());}Beanpublic

ApiInfo

ApiInfoBuilder().title(ycxct管理平台).description(ycxct管理平台

API接口文档).license(南京信息技术有限公司).licenseUrl().version(1.0).build();}

}Swagger3

过滤调用select方法通过apis方法basePackage可以根据包路径来生成特定类的APIany方法是默认所有都有效none方法都无效。

withClassAnnotation根据类注解withMethodAnntation是根据方法注解一般我们用的是basePackage方法。

控制器1

com.xct.swagger_1.controller.one;import

import

org.springframework.web.bind.annotation.*;/***

author

{ApiOperation(测试功能1)GetMapping(hello)public

String

HelloYc;}PostMapping(search)ApiImplicitParams({ApiImplicitParam(namename,value

姓名,requiredtrue,paramTypequery),ApiImplicitParam(name

age,value

Integer)})ApiOperation(测试查询)public

String

name:age;}ApiOperation(测试增加)PostMapping(add)public

String

user.getName():user.getAge();}GetMapping(user/{id})ApiOperation(根据id获取用户信息)ApiImplicitParams({ApiImplicitParam(name

id,value

path)})ApiResponses({ApiResponse(code500,message

后端代码错误),ApiResponse(code400,message

请求参数类型错误),ApiResponse(code404,message

请求路径错误)})public

com.xct.swagger_1.controller.two;import

import

org.springframework.web.bind.annotation.*;/***

author

{ApiOperation(测试功能2)GetMapping(hello2)public

String