Swagger(接口文档)的使用方式

最新推荐文章于 2024-08-08 10:30:00 发布

Be1iever

最新推荐文章于 2024-08-08 10:30:00 发布

阅读量250

点赞数

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/weixin_45400199/article/details/103341782

本文详细介绍了如何在项目中集成并配置Swagger2，包括导入依赖、编写配置类等步骤，以便快速生成API文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1. 导入依赖

 <!--引入swagger支持-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.9.2</version>
            </dependency>
            <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.9.2</version>
            </dependency>

2. 编写配置类

@Configuration
@EnableSwagger2 //开启swagger2的支持
public class Swagger2 {
 
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //对外暴露服务的包,以controller的方式暴露,所以就是controller的包.
                .apis(RequestHandlerSelectors.basePackage("com.zxh.crm.web.config"))
                .paths(PathSelectors.any())
                .build();
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("文档名字api")
                .description("接口文档说明")
                .contact(new Contact("user", "", "user@163.cn"))
                .version("1.0")
                .build();
    }
}