1、创建SpringBoot项目:
1.1、新建项目
注意:Java版本选择8:
1.2、添加依赖
spring-boot-starter-parent
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.4.RELEASE</version>
<relativePath/>
</parent>
添加SpringBoot web依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
1.3、配置application.yml文件
server:
port: 8090 #服务端口
spring:
application:
name: demo # 应用名称
1.4、创建controller
创建controller包,创建TestController类
@RestController
@RequestMapping("/api")
@CrossOrigin //跨域
public class TestController {
@GetMapping("/test")
public String test() {
return "hello";
}
}
1.5、测试
访问:http://localhost:8090/api/test
2、引入Swagger
作用:自动生成接口文档和测试页面:
2.1、引入依赖
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<!--swagger ui-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
2.2、Swagger配置文件
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("会员中心API")
.apiInfo(apiInfo())
.select()
//这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage("com.hkphantom.wxpay.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("后台-API文档")
.description("会员后台API文档")
.version("1.0")
.build();
}
}
2.3、Swagger注解
controller中可以添加常用注解
@Api(tags="测试类") //用在类上
@ApiOperation("测试接口") //用在方法上
swagger常用注解
// Swagger常用注解
@Api:修饰整个类,描述Controller的作用
@ApiOperation:描述一个类的一个方法,或者说一个接口
@ApiParam:单个参数的描述信息
@ApiModel:用对象来接收参数
@ApiModelProperty:用对象接收参数时,描述对象的一个字段
@ApiResponse:HTTP响应其中1个描述
@ApiResponses:HTTP响应整体描述
@ApiIgnore:使用该注解忽略这个API
@ApiError :发生错误返回的信息
@ApiImplicitParam:一个请求参数
@ApiImplicitParams:多个请求参数的描述信息
2.4、测试
添加swagger注解
@RestController
@RequestMapping("/api")
@CrossOrigin //跨域
@Api(tags="测试类") //用在类上
public class TestController {
@GetMapping("/test")
@ApiOperation("测试接口") //用在方法上
public String test() {
return "hello";
}
}
访问:http://localhost:8090/swagger-ui.html