* @author: youcong
* @time: 2020/11/14 15:46
*/@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfiguration {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(“com.blog.tutorial.controller”))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(“swagger-bootstrap-ui RESTful APIs”)
.description(“swagger-bootstrap-ui”)
.termsOfServiceUrl(“http://localhost:5050/”)
.contact(“developer@mail.com”)
.version(“1.0”)
.build();
}
}
三、启动项目
启动项目,不报错,然后访问地址:
http://ip:port/doc.html 即可
效果图,如下:
测试接口,效果图如下:
调式相当于用PostMan测试接口。
四、常用注解
和swagger一样,swagger用的注解,swagger-bootstrap-ui仍能用。
不过结合我的开发经验来看,最常用的也就两个,@Api和@ApiOperation。
@Api的效果,如图:
@ApiOperation的效果,如图:
由此,我们很容易就看出来,它们的含义是什么,一个是接口分类说明,一个是接口方法说明。
例子中的Controller代码:
package com.blog.tutorial.controller;
import com.blog.tutorial.entity.Users;
import com.blog.tutorial.service.UsersService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
/**
* @description:
* @author: youcong
* @time: 2020/11/14 13:27
*/@RestController
@RequestMapping(“/user”)
@Api(tags = {“用户管理”}, description = “用户管理”)
public class UserController {
@Autowired
private UsersService usersService;
@GetMapping(“/list”)
@ApiOperation(value = “用户列表”)
public List list() {
return usersService.list();
}
}
五、其它
关于swagger整合系列,可以参考如下:
https://www.cnblogs.com/youcong/p/9011302.html
关于swagger-bootstrap整合系列,可以参考:
https://www.cnblogs.com/youcong/p/9196157.html
https://www.cnblogs.com/youcong/p/10786371.html
六、可能遇到的问题
1.访问不到接口文档界面白版
一般是被拦截了(shiro或springsecurity机制)或者是配置错误。
2.访问接口文档界面出来了,但扫描不到接口
主要是配置类的缘故,配置类有个包扫描,必须配置为controller路径。
如图所示:
如果还有其它问题,可以去官方文档上找,官方文档有一个常规问题列表和解决方案,如图所示:
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)
最后
还有Java核心知识点+全套架构师学习资料和视频+一线大厂面试宝典+面试简历模板可以领取+阿里美团网易腾讯小米爱奇艺快手哔哩哔哩面试题+Spring源码合集+Java架构实战电子书+2021年最新大厂面试题。
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
频+一线大厂面试宝典+面试简历模板可以领取+阿里美团网易腾讯小米爱奇艺快手哔哩哔哩面试题+Spring源码合集+Java架构实战电子书+2021年最新大厂面试题。
[外链图片转存中…(img-ehNOvmFB-1713415204406)]
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!