Spring boot整合Springfox生成restful的在線api文檔

更新時(shí)間：2022年03月08日 09:42:55 作者：kl

這篇文章主要為大家介紹了Spring boot整合Springfox生成restful在線api文檔，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步

Springfox是什么，有什么用？

Springfox基于Swagger，能更方便的集成到spring boot 中，Swagger 是一個(gè)規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)。Swagger的目標(biāo)是對REST API定義一個(gè)標(biāo)準(zhǔn)的和語言無關(guān)的接口，可讓人和計(jì)算機(jī)無需訪問源碼、文檔或網(wǎng)絡(luò)流量監(jiān)測就可以發(fā)現(xiàn)和理解服務(wù)的能力。當(dāng)通過Swagger進(jìn)行正確定義，用戶可以理解遠(yuǎn)程服務(wù)并使用最少實(shí)現(xiàn)邏輯與遠(yuǎn)程服務(wù)進(jìn)行交互。與為底層編程所實(shí)現(xiàn)的接口類似，Swagger消除了調(diào)用服務(wù)時(shí)可能會(huì)有的猜測。

Springfox官方文檔：http://springfox.github.io/springfox/docs/snapshot/

Springfox的依賴

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>

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("自己平臺(tái)的api",//大標(biāo)題
                "swagger搭建api平臺(tái)",//小標(biāo)題
                "1.0",//版本
                "NO terms of service",
                "632104866@qq.com",//作者
                "這是我的技術(shù)博客站點(diǎn)",//鏈接顯示文字
                "http://www.kailing.pub"http://網(wǎng)站鏈接
        );
        return apiInfo;
    }
}

測試的Controll

@RestController
@RequestMapping("/user")
public class SwaggerDemoController {
    @RequestMapping(value = "/demo2",method = RequestMethod.POST)
    @ApiOperation(value="測試接口1", notes="測試接口詳細(xì)描述")
    @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="測試接口詳細(xì)描述",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 //使用這個(gè)注解忽略這個(gè)接口
    @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在線文檔整合完成了，下面是效果圖