1、添加swagger2的依赖
<!-- Swagger核心包 start --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency> <!-- 美化界面 wangmx --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.6</version> </dependency> <!-- Swagger核心包 end -->
2、添加一个swagger的配置类SwaggerConfig.class内容如下
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
Predicate<RequestHandler> predicate = new Predicate<RequestHandler>() {
@Override
public boolean apply(RequestHandler input) {
Class<?> declaringClass = input.declaringClass();
if (declaringClass == BasicErrorController.class)// 排除
return false;
if(declaringClass.isAnnotationPresent(RestController.class)) // 被注解的类
return true;
if(input.isAnnotatedWith(ResponseBody.class)) // 被注解的方法
return true;
return false;
}
};
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.useDefaultResponseMessages(false)
.select()
.apis(predicate)
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("我的内管系统接口文档")//大标题
.version("1.0")//版本
.build();
}
}
3、在被restController.class注解的类下添加swagger的注解,规则可以参考
https://blog.csdn.net/weixin_41846320/article/details/82970204
4、下面是我写的一个demo
/**
* 根据ID 获取用户信息
* @param userId
* @date: 2021/3/4
* @return 用户信息
**/
@GetMapping("/getUserById")
@ApiOperation(value = "根据ID获取用户信息", notes = "用户信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "userId",value = "用户ID",required = true,dataType = "String",paramType = "query")
})
public WebResponse getUserById(String userId){
return userService.getUserById(userId);
}
/**
* 新增用户信息
* @param userRequestDto
* @return WebResponse
*/
@ApiOperation(value = "用户新增",notes="密码默认123456")
@PostMapping("/addUser")
public WebResponse addUser(@Validated @RequestBody UserRequestDto userRequestDto){
return userService.addUser(userRequestDto);
}
5、运行结果如下(这里要注意以下show/hide按钮),刚打开是是隐藏的,一定要点一下show/hide才会显示你注解的接口
版权声明:本文为xizhangyan原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。