相信各位在公司写API文档数量应该不少,当然如果你还处在自己一个人开发前后台的年代,当我没说,如今为了前后台更好的对接,还是为了以后交接方便,都有要求写API文档。常用的工具有诸如小幺鸡、showdoc等,不过都需要人工进行编辑,大大影响了效率,或者是无法在线测试,接口更改后又得重新修改接口文档。
Swagger也就是为了解决这个问题,当然也不能说Swagger就一定是完美的,当然也有缺点,最明显的就是代码移入性比较强。其他的不多说,想要了解Swagger的,可以去Swagger官网,可以直接使用Swagger editor编写接口文档,当然我们这里讲解的是SpringBoot整合Swagger2,直接生成接口文档的方式。
一、pom导包
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>spring-boot-starter-swagger</artifactId>
<version>1.5.1.RELEASE</version>
</dependency>
二、swagger配置编写,application.yml
swagger:
# 是否启用swagger,默认:true
enabled: true
# 标题
title: swagger-demo API 管理
# 描述
description: 这里是 swagger-demo API 管理的描述信