springboot集成swagger3與knife4j的詳細代碼

更新時間：2022年08月16日 16:06:20 作者：卑微小鐘

這篇文章主要介紹了springboot集成swagger3與knife4j，本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下

springboot集成swagger3

swagger3的springboot啟動器jar包

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

注意：當前SpringBoot版本為2.5.6，Swagger3.0目前無法完全兼容SpringBoot2.6.x！

編寫TestController代碼

@RestController
@RequestMapping("test")
public class TestController {
    @GetMapping
    public Map<String, Object> get(@RequestParam String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @PostMapping
    public Map<String, Object> post() {
        Map<String, Object> r = new HashMap<>(1);
        r.put("code", 200);
        return r;
    }
    @PutMapping
    public Map<String, Object> put(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @DeleteMapping
    public Map<String, Object> delete(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }
}

創(chuàng)建Swagger3Configuration

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    private static final String VERSION = "0.0.1";
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .groupName("分組名稱")
                .apiInfo(apiInfo())
                .select()
                //要掃描的包
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 設置標題
                .title("文檔標題")
                //聯系人
                .contact(contact())
                //描述
                .description("xxx文檔")
                //服務
                .termsOfServiceUrl("https://spring.io/")
                //許可證
                .license("Apache 2.0")
                .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
                .version(VERSION)
                .build();
    }
    private Contact contact (){
        return new Contact("SpringBoot", "https://spring.io/", "email");
    }
}

運行演示

訪問網址：http://127.0.0.1:8081/swagger-ui/index.html

對接口進行注解

swagger中常用的注解

注解	作用	使用位置
@Api	表示對類的說明常用參數	類
@ApiOperation	說明方法的用途	方法
@ApiImplicitParams	里面可以包含多個@ApiImplicitParam	方法
@ApiImplicitParam	描述參數的用途	方法
@ApiModel	表示一個數據類的信息	類
@ApiModelProperty	描述數據類的屬性	屬性
@ApiIgnore	忽略某個字段使之不顯示在文檔中	屬性

接口基本使用

1.新建一個用戶實體類

@ApiModel("用戶")
@Data
public class User {
    @ApiModelProperty("用戶名")
    private String username;
    @ApiModelProperty("密碼")
    private String password;
}

2.給TestController添加注解

@Api(tags = "測試接口")
@RestController
@RequestMapping("test")
public class TestController {
    @ApiOperation("get請求")
    @GetMapping
    @ApiImplicitParam(name = "id", value = "測試用id", dataTypeClass = String.class)
    public Map<String, Object> get(@RequestParam String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @ApiOperation("post請求")
    @PostMapping
    public Map<String, Object> post(@RequestBody User user) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("code", 200);
        return r;
    }

    @ApiOperation("put請求")
    @PutMapping
    @ApiImplicitParam(name = "id", value = "put請求id", dataTypeClass = String.class)
    public Map<String, Object> put(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @ApiOperation("delete請求")
    @DeleteMapping
    @ApiImplicitParam(name = "id", value = "delete請求id", dataTypeClass = String.class)
    public Map<String, Object> delete(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }
}

運行結果

在這里插入圖片描述

集成更好的UI-knife4j

maven

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-micro-spring-boot-starter</artifactId>
   <version>3.0.3</version>
</dependency>

啟動器

在SwaggerConfig類上添加**@EnableKnife4j**

@Configuration
@EnableOpenApi
@EnableKnife4j
public class SwaggerConfig

訪問網站：http://127.0.0.1:8080/doc.html#/home

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

您可能感興趣的文章:

SpringBoot整合Redis并且用Redis實現限流的方法附Redis解壓包
這篇文章主要介紹了SpringBoot整合Redis并且用Redis實現限流的方法附Redis解壓包,本文給大家介紹的非常詳細,感興趣的朋友跟隨小編一起看看吧
2024-06-06
java 中HashCode重復的可能性
這篇文章主要介紹了java 中HashCode重復的可能性的相關資料,這里提供實例及測試代碼，需要的朋友可以參考下
2017-07-07
通過簡單步驟實現SpringMVC文件上傳
這篇文章主要介紹了通過簡單步驟實現SpringMVC文件上傳,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
2019-11-11
Spring中@DependsOn注解的使用代碼實例
這篇文章主要介紹了Spring中@DependsOn注解的使用代碼實例,Spring中@DependsOn,主要是使用在類和方法上, 作用是當前對象要依賴另外一些對象,被依賴的對象會先注冊到Spring的IOC容器中,需要的朋友可以參考下
2024-01-01
IDEA生成servlet程序的實現步驟
這篇文章主要介紹了IDEA生成servlet程序的實現步驟，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2021-03-03
基于logback 實現springboot超級詳細的日志配置
java web 下有好幾種日志框架，比如：logback，log4j，log4j2（slj4f 并不是一種日志框架，它相當于定義了規(guī)范，實現了這個規(guī)范的日志框架就能夠用 slj4f 調用）。這篇文章主要介紹了基于logback springboot超級詳細的日志配置,需要的朋友可以參考下
2019-06-06
Spring Boot定時任務的使用方法
這篇文章為大家詳細主要介紹了Spring Boot定時任務的使用方法，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2018-08-08
IntelliJ IDEA查看方法說明文檔的圖解
今天小編就為大家分享一篇關于IntelliJ IDEA查看方法說明文檔的圖解，小編覺得內容挺不錯的，現在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧
2018-10-10
詳解如何更改SpringBoot TomCat運行方式
這篇文章主要介紹了詳解如何更改SpringBoot TomCat運行方式，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2021-04-04
深入理解hibernate的三種狀態(tài)
本篇文章主要介紹了深入理解hibernate的三種狀態(tài) ，主要包括了transient(瞬時狀態(tài))，persistent(持久化狀態(tài))以及detached(離線狀態(tài))，有興趣的同學可以了解一下
2017-05-05