Bagaimana springboot mengintegrasikan springdoc

Langkah-langkah untuk menyepadukan springdoc: 1. Tambah kebergantungan; 3. Konfigurasi kelas Swagger3Config 5. Buat antara muka dan anotasi API; . Pengenalan terperinci: 1. Tambah kebergantungan, tambah kebergantungan Springdoc dalam fail pom.xml projek Spring Boot 2. Fail konfigurasi, dalam projek Spring Boot, dsb.

Sistem pengendalian tutorial ini: sistem Windows 10, komputer DELL G3.

Untuk menyepadukan Spring Boot dan Springdoc, anda boleh mengikuti langkah-langkah di bawah:

1. Tambahkan dependensi

Dalam fail pom.xml projek Spring Boot anda, tambahkan kebergantungan Springdoc. Berikut ialah contoh:

<dependency>  
    <groupId>org.springdoc</groupId>  
    <artifactId>springdoc-openapi-ui</artifactId>  
    <version>1.5.3</version>  
</dependency>

2. Fail konfigurasi

Dalam fail application.yml projek Spring Boot anda, tambahkan konfigurasi berikut:

springdoc:  
  api-docs:  
    enabled: true # 开启文档功能，默认为true，可不配置  
  swagger-ui:  
    path: /api # 访问路径，默认为/swagger-ui.html

3 Konfigurasikan kelas Swagger3Config

kelas, Dan melaksanakan antara muka OpenAPISchemaConverter. Kelas ini digunakan untuk mengkonfigurasi parameter berkaitan Swagger3. Berikut ialah contoh:

@Configuration  
public class Swagger3Config {  
    @Bean  
    public OpenAPISchemaConverter openAPISchemaConverter() {  
        return new OpenAPISchemaConverter();  
    }  
}

4 Cipta kelas DTO

Buat kelas DTO (Data Transfer Object) untuk mentakrifkan model permintaan dan respons API. Gunakan anotasi Swagger untuk menerangkan medan dan jenis model. Berikut ialah contoh:

@ApiModel(description = "用户模型")  
public class UserDTO {  
    @ApiModelProperty(notes = "用户ID", required = true)  
    private Long id;  
    @ApiModelProperty(notes = "用户姓名", required = true)  
    private String name;  
    // 其他字段和注解...  
}

5 Cipta antara muka dan anotasi API

Dalam lapisan perkhidmatan atau lapisan pengawal anda, buat antara muka dan anotasi API dan gunakan anotasi Swagger untuk menerangkan laluan API, kaedah permintaan, parameter, dsb. maklumat. Berikut ialah contoh:

@RestController  
@RequestMapping("/api")  
public class UserController {  
    @ApiOperation(value = "获取用户信息", notes = "根据ID获取用户信息")  
    @ApiImplicitParams({@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")})  
    @GetMapping("/user/{id}")  
    public ResponseEntity<UserDTO> getUserById(@PathVariable Long id) {  
        // 实现获取用户信息的逻辑...  
    }  
}

6 Mulakan aplikasi dan akses halaman dokumentasi API

Mulakan aplikasi Spring Boot anda dan masukkan alamat akses aplikasi dalam penyemak imbas. Anda sepatutnya dapat melihat antara muka UI Swagger, yang mengandungi dokumentasi API anda dan antara muka API yang tersedia.

Atas ialah kandungan terperinci Bagaimana springboot mengintegrasikan springdoc. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!