怎样与前端协助开发

与前端工程师协同开发的工具–Swagger

使用工具tomcat7 jdk8 IDEA Swagger

第一步在pom.xml中导入包

<!-- 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>

第二步在启动类上配置注解@EnableSwagger2

@SpringBootApplication

@EnableSwagger2

public class HotelApplication {
    public static void main(String[] args) {
        
        SpringApplication.run(HotelApplication.class, args);
    }
}

第三步启动项目

第四步浏览器访问此地址 http://localhost:8080/swagger-ui.html

出现此页面证明访问成功

附加条件
在方法名和字段上添加swagger文档中的信息
在方法上添加 @ApiOperation(value=”该方法的作用”)
在字段上添加 @ApiModelProperty(value =”该字段是干嘛用的”)
添加在参数上 @ApiParam(“该参数是干嘛用的”)

这三个注解，方便与前端小姐姐沟通噢