快捷導(dǎo)航

spring boot 集成 swagger3及配置方法

更新時(shí)間：2023年05月24日 11:36:39 作者：沒(méi)毛的刷子

Swagger 3是一種開(kāi)源的API描述工具，它可以幫助開(kāi)發(fā)人員設(shè)計(jì)、構(gòu)建、文檔化和測(cè)試API，這篇文章主要介紹了spring boot 集成 swagger3,需要的朋友可以參考下

Swagger 3是一種開(kāi)源的API描述工具，它可以幫助開(kāi)發(fā)人員設(shè)計(jì)、構(gòu)建、文檔化和測(cè)試API。Swagger 3支持多種編程語(yǔ)言和框架，包括Java、Node.js、Python、Ruby等，并提供了許多集成工具和插件，例如Postman、Apigee等。 Swagger 3使用OpenAPI規(guī)范來(lái)描述API，這是一種通用的API描述語(yǔ)言，適用于各種編程語(yǔ)言和框架。OpenAPI規(guī)范定義了API的基本結(jié)構(gòu)、請(qǐng)求和響應(yīng)的參數(shù)、頭部信息、路徑、HTTP方法和安全方案等。通過(guò)使用Swagger 3，開(kāi)發(fā)人員可以從API文檔中快速了解API的特點(diǎn)和功能，有效簡(jiǎn)化了API的構(gòu)建維護(hù)。在使用Swagger 3時(shí)，您需要在項(xiàng)目中添加Swagger 3依賴項(xiàng)，并配置好Swagger 3配置文件。然后您可以使用注釋標(biāo)記您的API端點(diǎn)以及請(qǐng)求和響應(yīng)類(lèi)和字段等，Swagger 3會(huì)根據(jù)這些注釋生成API文檔并提供UI界面進(jìn)行瀏覽和測(cè)試等操作。

引入依賴

注：不需要額外依賴，只需要下面一個(gè)就能完成

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-boot-starter</artifactId>
      <version>3.0.0</version>
</dependency>

配置文件

?spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

swagger配置類(lèi)

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 java.util.ArrayList;
/**
 * swagger配置
 */
@Configuration
public class SwaggerConfig {
    Boolean swaggerEnabled = true;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                // 是否開(kāi)啟
                .enable(swaggerEnabled)//true
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.***.***")//配置掃描的路徑
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("****接口文檔")
                .contact(new Contact("clc", "http://www.baidu.com", "clc@x.com"))
                .version("1.0")
                .description("基本的一些接口說(shuō)明")
                .license("Apache 2.0 許可") // 許可
                .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0") // 許可鏈接
                .extensions(new ArrayList<>()) // 拓展
                .build();
    }
}

常用注解

Swagger3 常用注解	使用位置
@Api	在 Java 類(lèi)上添加該注解。
@ApiOperation	在 Java 類(lèi)的方法上添加該注解。
@ApiParam	在 Java 類(lèi)的方法參數(shù)上添加該注解。
@ApiResponses	在 Java 類(lèi)的方法上添加該注解。
@ApiSecurity	在 Java 類(lèi)的方法上添加該注解。
@ApiModel	在 Java 類(lèi)的方法參數(shù)或返回值上添加該注解。
@ApiImplicitParams	在 Java 類(lèi)的方法參數(shù)上添加該注解。
@ApiHeader	在 Java 類(lèi)的方法參數(shù)或返回值上添加該注解。
@ApiFormData	在 Java 類(lèi)的方法參數(shù)或返回值上添加該注解。
@ApiUseDefaultValues	在 Java 類(lèi)的方法參數(shù)上添加該注解。