Springboot整合swagger

1.pom配置：

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

2. 配置类配置swagger：

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author lujs
 * @date 2020/8/13 9:05
 * @since 1.0.0
 */
@Configuration
@EnableSwagger2
public class SwaggerApp {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.lu.test"))
                .paths(PathSelectors.any())
                .build();
//        return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot 使用 Swagger2 构建RESTful API")
                //创建人
                .contact(new Contact("tom", "http://tom.com", ""))
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

3. controller类注解：

@Api(description = "测试接口")
@RestController
@RequestMapping("/api")
public class DemoController {

    @Autowired
    private DemoDao demoDao;


    @ApiOperation(value = "demo接口",notes = "测试")
    @ApiImplicitParams(value = {
            @ApiImplicitParam(name = "name",value = "姓名",dataType = "String", required = false,paramType = "query")
    })
    @GetMapping("/demo")
    public String demo(String name) {
        Object test = demoDao.test();
        return JSON.toJSONString(test);
    }

    @GetMapping("/open/test")
    public String test() {
        return "tom";
    }
 
}

4. 访问  访问 http://localhost:8080/swagger-ui.html

 

 

 

 

来源：oschina

链接：https://my.oschina.net/u/3534977/blog/4489980