SpringBoot 集成 springfox-swagger2

SpringBoot 集成 springfox-swagger2

依赖 jar 包

在 maven 的 pom.xml 文件中添加相关依赖。

    <properties>
        <swagger.version>2.8.0</swagger.version>
    </properties>
	
	<dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>
	</dependencies>
	
	<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>${swagger.version}</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>${swagger.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

创建 swagger 的配置类

在项目下创建 Swagger2Config.java 文件，写入以下内容。

@EnableSwagger2
@Configuration
public class Swagger2Config {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 自行修改为自己的包路径
                .apis(RequestHandlerSelectors.basePackage("com.changhr.cloud.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("api文档")
                .description("restful 风格接口")
                // 服务条款网址
                .termsOfServiceUrl("https://lovemengya.cn")
                .version("1.0")
                .contact(new Contact("浩然","http://lovemengya.cn", "changhr2013@outlook.com"))
                .build();
    }
}

swagger 注解

为需要用 swagger 做接口文档的 controller 添加相关注解

@RestController
@Api("MovieController 相关的 API")
public class MovieController {

    private static Logger logger = LoggerFactory.getLogger(MovieController.class);

    @Autowired
    private UserFeignClient userFeignClient;

    @ApiOperation(value = "根据 Id 查询用户信息", notes = "查询数据库中某个用户的信息")
    @ApiImplicitParam(name = "id", value = "用户 ID", paramType = "path", required = true, dataType = "Long")
    @GetMapping("/user/{id}")
    public User findById(@PathVariable("id") Long id) {
        return this.userFeignClient.findById(id);
    }
}