最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

SpringBoot3集成Swagger3的詳細教程

 更新時間：2024年03月08日 10:55:47   作者：洛可可白  
Swagger 3（OpenAPI 3.0）提供了更加強大和靈活的API文檔生成能力,本教程將指導您如何在Spring Boot 3項目中集成Swagger3,并使用Knife4j作為UI界面,需要的朋友可以參考下

Swagger是一個用于設計、構建、記錄和使用RESTful web服務的開源軟件框架。Swagger 3（OpenAPI 3.0）提供了更加強大和靈活的API文檔生成能力。本教程將指導您如何在Spring Boot 3項目中集成Swagger3，并使用Knife4j作為UI界面。

1. 添加依賴

首先，您需要在項目的pom.xml文件中添加Swagger3的依賴。同時，為了確保依賴能夠正確下載，您可以添加阿里云的Maven鏡像倉庫。

        <!--swagger3-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
            <version>4.1.0</version>
        </dependency>


    <repositories>
        <!--阿里云鏡像-->
        <repository>
            <id>alimaven</id>
            <name>aliyun maven</name>
            <url>https://maven.aliyun.com/nexus/content/groups/public/</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>

2. 配置Swagger

在Spring Boot項目中創(chuàng)建一個配置類SwaggerConfig，并添加Swagger的配置信息。

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {
    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("標題")
                        .contact(new Contact())
                        .description("我的API文檔")
                        .version("v1")
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("外部文檔")
                        .url("https://springshop.wiki.github.org/docs"));
    }
}

3. 實體類和控制層注解

在您的實體類和控制層中使用Swagger注解來描述API。

// 實體類注解示例
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

import java.util.Date;

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
@Schema(name = "Employee", description = "$!{table.comment}")
public class Emp {
    @ExcelProperty("ID")
    @Schema(description = "ID")
    private int id;
    @ExcelProperty("用戶名")
    @Schema(description = "用戶名")
    private String names;
    @ExcelProperty("工資")
    @Schema(description = "工資")
    private double salary;
    @ExcelProperty("生日")
    @Schema(description = "生日")
    private Date birthday;
    @ColumnWidth(20)
    @ExcelProperty("頭像")
    @Schema(description = "頭像")
    private String photo;
    
//    @ColumnWidth(20)
//    @DateTimeFormat("yyyy-MM-dd HH:mm:ss")
//    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
//    @ExcelProperty("創(chuàng)建日期")
//    private Date u_create_time;
}


// 控制層注解示例
import io.swagger.v3.oas.annotations.Operation;

@Operation(summary = "獲取所有員工信息")
@GetMapping("/selectAll")
public List<Emp> selectAll() {
    // ...
}

4. 通用返回結果封裝

創(chuàng)建一個通用的返回結果類，用于統(tǒng)一API的響應格式。

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;

@Builder(toBuilder = true)
@AllArgsConstructor
@Setter
@Getter
@Slf4j
public class Result<T> {
    /**
     * 提示信息
     */
    @Schema(description = "提示信息")
    private String message;
    /**
     * 是否成功
     */
    @Schema(description = "是否成功")
    private boolean success;
    /**
     * 返回狀態(tài)碼
     */
    @Schema(description = "返回狀態(tài)碼")
    private Integer code;
    /**
     * 數據
     */
    @Schema(description = "數據")
    private T data;

    public Result() {
    }

    public static Result success() {
        Result Result = new Result();
        Result.setSuccess(Boolean.TRUE);
        Result.setCode(ResultCode.SUCCESS.getCode());
        Result.setMessage(ResultCode.SUCCESS.getMsg());
        return Result;
    }

    public static Result success(String msg) {
        Result Result = new Result();
        Result.setMessage(msg);
        Result.setSuccess(Boolean.TRUE);
        Result.setCode(ResultCode.SUCCESS.getCode());
        return Result;
    }

    public static Result success(Object data) {
        Result Result = new Result();
        Result.setData(data);
        Result.setSuccess(Boolean.TRUE);
        Result.setCode(ResultCode.SUCCESS.getCode());
        Result.setMessage(ResultCode.SUCCESS.getMsg());
        return Result;
    }

    /**
     * 返回失敗 消息
     *
     * @return Result
     */
    public static Result failure() {
        Result Result = new Result();
        Result.setSuccess(Boolean.FALSE);
        Result.setCode(ResultCode.FAILURE.getCode());
        Result.setMessage(ResultCode.FAILURE.getMsg());
        return Result;
    }

    /**
     * 返回失敗 消息
     *
     * @param msg 失敗信息
     * @return Result
     */
    public static Result failure(String msg) {
        Result Result = new Result();
        Result.setSuccess(Boolean.FALSE);
        Result.setCode(ResultCode.FAILURE.getCode());
        Result.setMessage(msg);
        return Result;
    }

    public static Result failure(Integer code, String msg) {
        Result Result = new Result();
        Result.setSuccess(Boolean.FALSE);
        Result.setCode(code);
        Result.setMessage(msg);
        return Result;
    }


    public static Result failure(String msg, ResultCode exceptionCode) {
        Result Result = new Result();
        Result.setMessage(msg);
        Result.setSuccess(Boolean.FALSE);
        Result.setCode(exceptionCode.getCode());
        Result.setData(exceptionCode.getMsg());
        return Result;
    }

    /**
     * 返回失敗 消息
     *
     * @param exceptionCode 錯誤信息枚舉
     * @return Result
     */
    public static Result failure(ResultCode exceptionCode) {
        Result Result = new Result();
        Result.setSuccess(Boolean.FALSE);
        Result.setCode(exceptionCode.getCode());
        Result.setMessage(exceptionCode.getMsg());
        return Result;
    }

    /**
     * 返回失敗 消息
     *
     * @param exceptionCode 錯誤信息枚舉
     * @param msg           自定義錯誤提示信息
     * @return Result
     */
    public static Result failure(ResultCode exceptionCode, String msg) {
        Result Result = new Result();
        Result.setMessage(msg);
        Result.setSuccess(Boolean.FALSE);
        Result.setCode(exceptionCode.getCode());
        return Result;
    }

}

5. 注解說明

Swagger3的注解與Swagger2有所不同，以下是一些常用注解的對照表：

Swagger2注解Swagger3注解注解位置
@Api@Tag(name = “接口類描述”)Controller類上
@ApiOperation@Operation(summary = “接口方法描述”)Controller方法上
@ApiImplicitParams@ParametersController方法上
@ApiImplicitParam@Parameter(description = “參數描述”)Controller方法上
@ApiParam@Parameter(description = “參數描述”)方法參數上
@ApiIgnore@Parameter(hidden = true) 或 @Operation(hidden = true)-
@ApiModel@SchemaDTO類上
@ApiModelProperty@SchemaDTO屬性上

6. 訪問Swagger UI

啟動您的Spring Boot應用后，您可以通過以下地址訪問Swagger UI：

http://localhost:8080/doc.html
http://localhost:8080/swagger-ui/index.html

在這里，您可以查看API文檔，測試API接口，并獲取相關信息。

到此這篇關于SpringBoot3集成Swagger3的詳細教程的文章就介紹到這了,更多相關SpringBoot3集成Swagger3內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

相關文章

  • Java實現AES加密算法的簡單示例分享

    Java實現AES加密算法的簡單示例分享

    這篇文章主要介紹了Java實現AES加密算法的簡單示例分享,AES算法是基于對密碼值的置換和替代,需要的朋友可以參考下
    2016-04-04
  • java實現簡單的加減乘除計算器

    java實現簡單的加減乘除計算器

    這篇文章主要為大家詳細介紹了java實現簡單的加減乘除計算器，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
    2021-09-09
  • 重學SpringBoot3之日志Logging使用方式

    重學SpringBoot3之日志Logging使用方式

    在日常開發(fā)中會遇到不同的異常,日志方便我們去排查處理,這篇文章主要給大家介紹了關于重學SpringBoot3之日志Logging使用方式的相關資料,文中通過代碼介紹的非常詳細,需要的朋友可以參考下
    2024-06-06
  • JAVA用for循環(huán)打印空心菱形

    JAVA用for循環(huán)打印空心菱形

    大家好，本篇文章主要講的是JAVA用for循環(huán)打印空心菱形，感興趣的同學趕快來看一看吧，對你有幫助的話記得收藏一下
    2022-01-01
  • Java接口測試框架Restassured介紹及常用方法

    Java接口測試框架Restassured介紹及常用方法

    Java接口測試主要用于驗證Java應用程序中不同模塊或服務之間的交互是否符合預期,這篇文章主要介紹了Java接口測試框架Restassured介紹及常用方法的相關資料,文中通過代碼介紹的非常詳細,需要的朋友可以參考下
    2026-03-03
  • Spring?Data?JPA?映射VO/DTO對象方式

    Spring?Data?JPA?映射VO/DTO對象方式

    這篇文章主要介紹了Spring?Data?JPA?映射VO/DTO對象方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
    2021-11-11
  • pagehelper分頁工具類的封裝

    pagehelper分頁工具類的封裝

    這篇文章主要為大家詳細介紹了pagehelper分頁工具類的封裝，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
    2022-08-08
  • 一文系統(tǒng)梳理Java中字符串比較的高頻誤區(qū)

    一文系統(tǒng)梳理Java中字符串比較的高頻誤區(qū)

    本文圍繞?Java?字符串比較中的高頻誤區(qū)展開,系統(tǒng)梳理?==、equals()、字符串常量池、new?String()、編譯期與運行期拼接、final?常量折疊以及?intern()?的核心規(guī)則,希望幫助?Java?初學者真正理解?String?比較背后的引用關系與常見踩坑點
    2026-05-05
  • Spring MVC處理方法返回值過程解析

    Spring MVC處理方法返回值過程解析

    這篇文章主要介紹了Spring MVC處理方法返回值過程解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
    2020-02-02
  • struts2實現多文件上傳

    struts2實現多文件上傳

    這篇文章主要為大家詳細介紹了struts2實現多文件上傳，具有一定的參考價值，感興趣的小伙伴們可以參考一下
    2018-08-08

最新評論

准格尔旗| 康定县| 石家庄市| 容城县| 新丰县| 娱乐| 海丰县| 扎鲁特旗| 集贤县| 仙游县| 海阳市| 通化市| 闵行区| 吉木萨尔县| 棋牌| 永年县| 湟中县| 彭州市| 龙游县| 台中市| 内江市| 凉城县| 贞丰县| 平遥县| 芦溪县| 莫力| 清水县| 台中县| 萍乡市| 丹棱县| 深水埗区| 万源市| 斗六市| 洪泽县| 凯里市| 革吉县| 安丘市| 聂拉木县| 怀来县| 三门县| 台州市|