关于Swagger生成Api文档

张大得一熬弔

已于 2022-07-04 14:20:32 修改

阅读量331

点赞数 1

CC 4.0 BY-SA版权

分类专栏： Swagger 文章标签： java

于 2022-04-19 17:19:17 首次发布

本文链接：https://blog.csdn.net/yy991011/article/details/124276973

Swagger 专栏收录该内容

1 篇文章

订阅专栏

本文档详细介绍了如何在Spring Boot项目中集成并配置Swagger2，包括添加依赖、配置文件设定、启动类标识以及如何使用@Api和ApiOperation等注解进行API文档的构建。通过配置basePackage，你可以指定扫描特定包下的控制器，以展示对应的API。此外，还展示了如何创建多个不同的API组，如adminApiInfo，用于区分不同权限的API。最后，通过访问http://localhost:8080/swagger-ui.html#/，可以查看和测试生成的Swagger UI界面。

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

pom导包

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>

配置文件

@Configuartion //表明配置文件注解

public class Swagger 2Config {

@Bean

public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()

//basePackage后面路径，为扫描路径，在项目中的控制层controller

.apis(RequestHandlerSelectors.basePackage("com.fengmang.demo.controller"))
.paths(PathSelectors.any())
.build();
}

private ApiInfo apiInfo(){

return new ApiInfoBuilder()

@Configuration
@EnableSwagger2
public class Swagger2Config {
    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 指定扫描的包路径来定义指定要建立API的目录。
     * @return
     */
    @Bean
    public Docket coreApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(adminApiInfo())
                .groupName("adminApi")
                .select()
                //只显示admin下面的路径
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    }

    private ApiInfo adminApiInfo(){
        return new ApiInfoBuilder()
                .title("标签")
                .description("用途描述")
                .version("1.0")
                .contact(new Contact("名字","路径","邮箱"))
                .build();
    }
}

启动类加

@EnableSwagger2 开启Swagger