Swagger简单入门
学习目标:
- 了解swagger的作用和概念
- 了解前后端分离
- 在springboot中集成swagger
swagger简介
前后端分离
主流的解决方案:Vue+spring boot
前后端分离时代:
- 后端:后端控制层、服务层、数据访问层
- 前端:前端控制层、视图层
- 前后端如何交互:->通过API来来访问
- 前后端相互独立,耦合度低,前后端也可以部署在不同的服务器上
产生的问题:
- 前后端集成联调苦难,前端后端人员无法“及时沟通,尽早解决”,会导致问题集中爆发
解决方案:
- 首先指定schema【计划的提纲】,实时更新最新API,降低集成风险
- 前后端分离需要提供一个实时的接口工具(早期测试接口postman)
Swagger
- 号称世界上最流行的API框架
- RestFul API 文档在线自动生成工具->API文档和API的定义同步更新
- 直接运行,可以在线测试API接口
- 支持多种语言(Java、PHP等)
官网:https://swagger.io/
在项目中使用swagger
需要导入Java包
- swagger2
- ui
springboot集成swagger
1、新建springboot项目
2、导入相关依赖
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
3、编写helloworld进行测试
package edu.kuquan.swagger.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
// /error 默认的请求
@RequestMapping("/hello")
public String hello() {
return "Hello world!";
}
}
4、配置swagger(编写配置类)
package edu.kuquan.swagger.config;
import org.sp