章节
- 不再视野黑盒，一天学会简单使用springboot（1） - 掘金 (juejin.cn)
- 不再视野黑盒，新建springboot项目（2） - 掘金 (juejin.cn)
- 不再视野黑盒，整合mybatis plus（3） - 掘金 (juejin.cn)
- 不再视野黑盒，统一结果封装（4） - 掘金 (juejin.cn)
- 不再视野黑盒，整合shiro+jwt，并会话共享（5） - 掘金 (juejin.cn)
- 不再视野黑盒，异常处理&实体校验（6） - 掘金 (juejin.cn)
- 不再视野黑盒，swagger3集成（7） - 掘金 (juejin.cn)
- 不再视野黑盒，登录&增删改查（8） - 掘金 (juejin.cn)
官方网址：Swagger官网
使用Swagger的好处
-
无依赖
UI 适用于任何开发环境，无论是本地还是 Web。
-
人性化
允许最终开发人员轻松交互并尝试您的 API 公开的每一个操作，以便于使用。
-
易于导航
使用分类整齐的文档快速查找和使用资源和端点。
-
所有浏览器支持
通过适用于所有主要浏览器的 Swagger UI 迎合所有可能的场景。
-
完全可定制的
样式并通过完整的源代码访问以您想要的方式调整您的 Swagger UI。
-
完整的 OAS 支持
可视化 Swagger 2.0 或 OAS 3.0 中定义的 API。
01.引入swagger依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
02.在主类添加@EnableOpenApi开关注解
@SpringBootApplication
@EnableOpenApi
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
03.编写说明
- @Api(tags = "用户信息处理")
- @Operation(summary = "根据id查询用户信息")
@RestController
@RequestMapping("/user")
@Api(tags = "用户信息处理")
public class UserController {
@Autowired
UserService userService;
@GetMapping("/{id}")
@Operation(summary = "根据id查询用户信息")
public Object getId(@PathVariable("id") Long id) {
return userService.getById(id);
}
@PostMapping("/save")
public Object testUser(@Validated @RequestBody UserDemo user) {
return user.toString();
}
};
