Swagger是一個(gè)規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化RESTful風(fēng)格的Web服務(wù)。簡(jiǎn)單來說，Swagger是一個(gè)功能強(qiáng)大的接口管理工具，并且提供了多種編程語言的前后端分離解決方案。

• Swagger可以整合到代碼中，在開發(fā)時(shí)通過注解，編寫注釋，自動(dòng)生成API文檔；
• 方便前后端分離開發(fā)

swagger是什么？

API Developmentfor Everyone

springboot中集成swagger

1、添加pom依賴

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>

2、添加swagger配置

@EnableSwagger2 @RestController @SpringBootApplication public class FamilyServerApplication {public static void main(String[] args) {SpringApplication.run(FamilyServerApplication.class, args);}@RequestMapping("/")public String hello(){return "hello billy!";} }

3、在需要暴露的API上添加API注解

例如：

@Api("MemberManageController") @RestController @RequestMapping("member") public class MemberManageController extends BaseController {@Autowiredprivate MembersManageService manageService;/*** 獲取成員* @return*/@ApiOperation(value = "查詢家庭成員", notes = "查詢家庭成員")@ApiImplicitParams(@ApiImplicitParam(name = "name", value = "姓名", paramType = "query", dataType = "String"))@RequestMapping("getMembers")public Object getMembers(String name){logger.debug("開始。。。");System.out.println(name);Page<FamilyMembers> page = new Page<>();IPage<FamilyMembers> membersByPage = manageService.getMembersByPage(page);Messager result = messager.successObjectResponse(membersByPage);return result;} }

4、啟動(dòng)項(xiàng)目，訪問swagger-ui地址?

演示項(xiàng)目地址為：?http://localhost:9090/swagger-ui.html

結(jié)果如下：

5、接口調(diào)試

返回結(jié)果：

?

?

備注：項(xiàng)目開發(fā)中，如果前后端分離，采用swagger特別方便。

轉(zhuǎn)載于:https://www.cnblogs.com/BillyYoung/p/11024742.html

總結(jié)

以上是生活随笔為你收集整理的springboot 集成 swagger 自动生成API文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。