SpringBoot整合swagger ui。  三步就行。

1、pom.xml中新增依賴 

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

actual version is :

 <springfox.version>2.8.0</springfox.version>

2、增加配置的Bean 

package com.3fcode.cms.config;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2Config {


    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //掃描指定包中的swagger註解
                //掃描所有有註解的api，用這種方式更靈活
                .apis(RequestHandlerSelectors.basePackage("com.3fcode.cms.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("3fcode-CMS-api")
                .description("url新增字首:/gateway")
                .version("0.0.1")
                .build();
    }
}
 

3、然後就可以在controller裡面添加註釋 

@ApiOperation(value = “3fcode測試介面”, notes = “3fcode增加實體介面”) 
@RequestMapping(value = “/addObject”, method = RequestMethod.POST) 
public Object addObject(@RequestBody String requestMessage, HttpServletRequest request) { 
        ...... 
} 

4. 然後啟動應用就能訪問 swagger-ui.html看到生成出來的介面報文了。

http://localhost:8908/swagger-ui.html#

--done--