Rumah  >  Artikel  >  Java  >  Bagaimana springboot menyepadukan swagger3 dan knife4j

Bagaimana springboot menyepadukan swagger3 dan knife4j

王林
王林ke hadapan
2023-05-19 12:49:062034semak imbas

springboot menyepadukan swagger3

pakej balang pelancar springboot swagger3

<!-- 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>

Nota: Versi SpringBoot semasa ialah 2.5.6 dan Swagger3.0 pada masa ini tidak serasi sepenuhnya dengan SpringBoot2 .6. x!

Tulis kod 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;
    }
}

Buat 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");
    }
}

Annotate antara muka

Anotasi yang biasa digunakan dalam swagger
注解 作用 使用位置
@Api 表示对类的说明常用参数
@ApiOperation 说明方法的用途 方法
@ApiImplicitParams 里面可以包含多个@ApiImplicitParam 方法
@ApiImplicitParam 描述参数的用途 方法
@ApiModel 表示一个数据类的信息
@ApiModelProperty 描述数据类的属性 属性
@ApiIgnore 忽略某个字段使之不显示在文档中 属性
Penggunaan asas antara muka
1 Cipta kelas entiti pengguna baharu

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

2. Tambahkan anotasi pada 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;
    }
}

Hasil yang dijalankan

Bagaimana springboot menyepadukan swagger3 dan knife4j

Bagaimana springboot menyepadukan swagger3 dan knife4j

Bagaimana springboot menyepadukan swagger3 dan knife4jSepadukan UI-knife4j yang lebih baik

maven

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-micro-spring-boot-starter</artifactId>
   <version>3.0.3</version>
</dependency>
Pelancar
Tambah **@EnableKnife4j** pada kelas SwaggerConfig
@Configuration
@EnableOpenApi
@EnableKnife4j
public class SwaggerConfig

Atas ialah kandungan terperinci Bagaimana springboot menyepadukan swagger3 dan knife4j. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

Kenyataan:
Artikel ini dikembalikan pada:yisu.com. Jika ada pelanggaran, sila hubungi admin@php.cn Padam