springboot が springdoc を統合する方法

SpringBoot が springdoc を統合するための手順: 1. 依存関係を追加する; 2. 構成ファイル; 3. Swagger3Config クラスを構成する; 4. DTO クラスを作成する; 5. API インターフェイスと注釈を作成する; 6. アプリケーションを起動してアクセスするAPIドキュメントページ。詳細な導入: 1. 依存関係を追加し、Spring Boot プロジェクトの pom.xml ファイルに Springdoc 依存関係を追加します; 2. Spring Boot プロジェクトなどに構成ファイルを追加します。

このチュートリアルのオペレーティング システム: Windows 10 システム、DELL G3 コンピューター。

Spring Boot と Springdoc を統合するには、以下の手順に従います:

1. Spring Boot プロジェクトに依存関係

を追加します。 .xml ファイルに Springdoc 依存関係を追加します。以下は例です:

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

2. 構成ファイル

Spring Boot プロジェクトの application.yml ファイルに、次の構成を追加します:

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

3. Swagger3Config クラスの構成

Swagger3Config クラスを作成し、OpenAPISchemaConverter インターフェイスを実装します。このクラスは、Swagger3 の関連パラメーターを構成するために使用されます。以下に例を示します:

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

4. DTO クラスの作成

DTO (データ転送オブジェクト) クラスを作成して、API リクエストと応答のモデルを定義します。 Swagger アノテーションを使用して、モデルのフィールドと型を記述します。以下は例です:

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

5. API インターフェイスとアノテーションの作成

サービス層またはコントローラー層で、API インターフェイスとアノテーションを作成し、Swagger アノテーションを使用します。 API パス、リクエスト メソッド、パラメータ、その他の情報を記述するために使用されます。以下は例です:

@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. アプリケーションを起動して API ドキュメント ページにアクセスします

Spring Boot アプリケーションを起動し、ブラウザのアクセス アドレスにアプリケーションを入力します。 API ドキュメントと利用可能な API インターフェイスを含む Swagger UI インターフェイスが表示されるはずです。

以上がspringboot が springdoc を統合する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。