Springfox是什么，有什么用？

Springfox基于Swagger，能更方便的集成到spring boot 中，Swagger 是一個規范和完整的框架，用于生成、描述、調用和可視化 RESTful 風格的 Web 服務。Swagger的目標是對REST API定義一個標準的和語言無關的接口，可讓人和計算機無需訪問源碼、文檔或網絡流量監測就可以發現和理解服務的能力。當通過Swagger進行正確定義，用戶可以理解遠程服務并使用最少實現邏輯與遠程服務進行交互。與為底層編程所實現的接口類似，Swagger消除了調用服務時可能會有的猜測。

Springfox的依賴

io.springfox

springfox-swagger2

2.4.0

io.springfox

springfox-swagger-ui

2.4.0

Springfox的配置

@Configuration

@EnableSwagger2

public class SwaggerConfig {

@Bean

public Docket demoApi() {

return new Docket(DocumentationType.SWAGGER_2)

.groupName("demo")

.genericModelSubstitutes(DeferredResult.class)

.useDefaultResponseMessages(false)

.forCodeGeneration(false)

//.pathMapping("/") //根路徑

.select()

.paths(PathSelectors.regex("/user/.*"))//篩選展示的接口，使用PathSelectors.any()，展示所有接口

.build()

.apiInfo(demoApiInfo())

;

}

//api信息

private ApiInfo demoApiInfo() {

ApiInfo apiInfo = new ApiInfo("自己平臺的api",//大標題

"swagger搭建api平臺",//小標題

"1.0",//版本

"NO terms of service",

"632104866@qq.com",//作者

"這是我的技術博客站點",//鏈接顯示文字

"http://www.kailing.pub"//網站鏈接

);

return apiInfo;

}

}

測試的Controll

@RestController

@RequestMapping("/user")

public class SwaggerDemoController {

@RequestMapping(value = "/demo2",method = RequestMethod.POST)

@ApiOperation(value="測試接口1", notes="測試接口詳細描述")

@ResponseBody

ModelMap getDemo(@RequestBody User user) {

ModelMap map = new ModelMap();

map.addAttribute("userId", 111);

map.addAttribute("userName", "kl博客");

return map;

}

@ResponseBody

@RequestMapping(value = "/demo3", method = RequestMethod.POST)

@ApiOperation(value="測試接口2", notes="測試接口詳細描述",code = 200,produces = "application/json")

public ModelMap getDemoa(@RequestParam("name") String demoName, @RequestParam String content) {

ModelMap map = new ModelMap();

map.addAttribute("result",demoName + "AAA");

return map;

}

@ResponseBody

@ApiIgnore //使用這個注解忽略這個接口

@RequestMapping(value = "/demo4", method = RequestMethod.POST)

public ModelMap getDemob(@RequestParam String content) {

ModelMap map = new ModelMap();

map.addAttribute("result",new java.util.Date());

return map;

}

}

在瀏覽器輸入http://localhost:8080/swagger-ui.html，可查看是否整合成功

至此我們的額api在線文檔整合完成了，下面是效果圖

總結

以上是生活随笔為你收集整理的springfox源码_Spring boot整合Springfox在线生成restful的api doc的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。