spring boot 整合 swagger自动生成接口文档，搬砖都快乐了~

你是否还在为本就紧张的开发排期还要写接口文档而痛苦？
你是否还在为写接口文档比写接口还痛苦？

那么swagger后端童鞋值得拥有，
spring boot作为最懂程序员的框架，当然为我们想到啦，so easy

1、pom.xml 中引入依赖

            org.springframework.boot
            spring-boot-starter-web
            2.1.18.RELEASE
        
        
            com.github.xiaoymin
            knife4j-spring-boot-starter
            2.0.7
        
1
2
3
4
5
6
7
8
9
10

然后点击maven刷新，就看见它迈着正步走来了~

2、启动上加上启用swagger注解@EnableSwagger2WebMvc

3、好啦，这两步环境就准备完了，easy easy~，可以开始写你的接口文档了
3.1搞个controller,写个接口，加上swagger注解

• @Api注解放在类上
• @ApiOperation注解放在接口上

@RestController
@Api(tags = "panda的地盘")
public class PandaController {
    @GetMapping("/panda")
    @ApiOperation(value = "panda的接口")
    public void panda(){
        System.out.println("hello panda");
    }
}
1
2
3
4
5
6
7
8
9

4、启动项目，访问swagger吧，地址http://localhost:8080/doc.html
这开心的一幕不就来了。。

5、再搞个post接口，试试model的注释吧
5.1 搞个model

• @ApiModel 放在类上
• @ApiModelProperty 放在属性上

@ApiModel(value = "panda的model")
public class Panda {
    @ApiModelProperty(value = "panda的大名")
    private String name;
    @ApiModelProperty(value = "panda的爱好")
    private String like;
}
1
2
3
4
5
6
7

5.2搞个post接口,Panda作为入参，body方式接受

@PostMapping("/panda2")
@ApiOperation(value = "panda的接口2")
public void panda2(HttpServletResponse response,@RequestBody Panda panda) throws IOException {
    String str = "hello "+panda.getName()+", i know you like "+panda.getLike();
    response.getWriter().write(str);
}
1
2
3
4
5
6

6、启动项目看看吧
model和属性的注释就都来啦，一看就是梦中情文档

7、可以在调试页面进行测试，就跟postman一样

这就ok啦，地址扔给前端，又可以做个安静的码农快乐的搬砖啦~