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ù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
您可能感興趣的文章:
- Springboot3集成Knife4j的步驟以及使用(最完整版)
- SpringBoot?Knife4j框架&Knife4j的顯示內容的配置方式
- SpringBoot與knife4j的整合使用過程
- springboot讀取bootstrap配置及knife4j版本兼容性問題及解決
- springboot3整合knife4j詳細圖文教程(swagger增強)
- springboot整合knife4j全過程
- knife4j?整合?springboot的過程詳解
- SpringBoot中使用Knife4J的解決方案
- Springboot中整合knife4j接口文檔的過程詳解
- knife4j+springboot3.4異常無法正確展示文檔
相關文章
MyBatis實現Mysql數據庫分庫分表操作和總結(推薦)
這篇文章主要介紹了MyBatis實現Mysql數據庫分庫分表操作和總結,需要的朋友可以參考下2017-08-08