<!-- 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！
@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;
}
}@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");
}
}| #註解 | 作用 | 使用位置 |
|---|---|---|
| @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;
}
}
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-micro-spring-boot-starter</artifactId> <version>3.0.3</version> </dependency>
#
@Configuration @EnableOpenApi @EnableKnife4j public class SwaggerConfig
以上是springboot怎麼整合swagger3與knife4j的詳細內容。更多資訊請關注PHP中文網其他相關文章！
