Swagger自动化管理API

最新推荐文章于 2025-09-05 03:37:11 发布

原创最新推荐文章于 2025-09-05 03:37:11 发布 · 652 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#后端

工具专栏收录该内容

3 篇文章

订阅专栏

本文详细介绍如何使用Swagger2自动生成API文档，包括配置pom依赖、创建Swagger配置类及查看效果的方法。Swagger2是一款开源工具，能为RESTful API提供强大的文档生成支持。

特点

自动生成API的工具
开源

结果展示

为了首先看到它的强大之处，我先在这里贴张图片供大家查看。

使用

pom依赖

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <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>

Swagger 配置类

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

/**
 * Swagger2 配置类
 */
@Configuration 
// 开启Swagger2
@EnableSwagger2  
public class SwaggerConfig {

    /**
     * Docket实例
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bcm.task.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * Swagger apiInfo
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("标题")
                .contact(new Contact("介绍", "官网", "邮箱"))
                .version("1.0")  // 版本号
                .description("Api 描述")
                .build();
    }
}