openapi-generatorを用いての自動生成

1.目的

　Java Spring BootにてWeb APIを作成する際に、プラグインの「openapi-generatorr」を使用することにより、作成したOpenAPIを元に、Spring BootでRest APIのリクエスト、レスポンスで使用する項目のプロパティを自動生成でき、また、RestAPIのコントローラで使用する呼び出し用のメソッドやレスポンスモデルを自動生成してくれます。
これらについて、記事を残します。

2.環境

　　　eclipse（Version: 2022-12 (4.26.0))
　　　java（ver.17)
　　　spring boot 3.1.1
　　　Gradle - Groovy

3.手順

(1)　資材をコピーする階層を確認する。

(2) (1)の階層に、 git(※事前にGitをダウンロードしておく）などを使用して、以下のサイトより資材をコピーする。

https://github.com/OpenAPITools/openapi-generator

※コピー時は「git clone 【URL】」でダウンロードする。

(3) コピーできたことを確認する。（openapi-generator）

　　①【clone中】

　　②【clone後】

(4) EclipseでJavaのSpring Boot(Gradle)を作成（事前に作っていても問題なし）

またプロジェクト内にOpenApi用のフォルダに対象のOpenAPIを配置する

【対象のOpenAPI】

(5) eclipseのプラグイン用のフォルダへ3.でダウンロードしたフォルダを配置（コピー）する。

　　①（コピー先）【C:\pleiades\2022-12\eclipse\plugins】
　　②（コピー元）（１）の階層
　　③【配置時】

(6) フォルダ名称を「org.openapi.generator」へ変更する（その他のライブラリ名と合わせる）

　　①【コピー後（名称変換前】

　　②【コピー後（名称変換後】

(7) eclipseで、「openapi-generator」を表示させる。

　　①「build.gradle」を開く。

　　② 初期の内容に対して「// 追加」のところを変更する。

build.gradle

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.1.1'
	id 'io.spring.dependency-management' version '1.1.0'
	id "org.openapi.generator" version "6.2.0"　// 追加
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'　// 追加

java {
	sourceCompatibility = '17'
}

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

// 追加　Start
ext {
        // 出力先を設定
        openApiOutputDir = "$rootDir/generated"
}
//　出力したソースをビルドパスに追加
sourceSets.main.java.srcDirs += ["$openApiOutputDir/src/main/java"]
// 追加　End

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
// 追加　Start
	// 依存性を追加
	implementation 'org.openapitools:jackson-databind-nullable:0.2.1'
	implementation 'org.springframework.boot:spring-boot-starter-validation'
	implementation group: 'org.springdoc', name: 'springdoc-openapi-ui', version: '1.6.9'
	compileOnly 'io.swagger:swagger-annotations:1.6.2'
// 追加　End
	compileOnly 'org.projectlombok:lombok'
	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
// 追加　Start
// （openApiの設定を追加）
openApiGenerate {
        generatorName = 'spring'
        inputSpec = "$rootDir/openapi/shukanTalentJohoBFF.yaml".toString() //対象のOpenAPI
        outputDir = "$openApiOutputDir"
        apiPackage = 'com.api'
        modelPackage = 'com.model'
        invokerPackage = "org.openapi.example.invoker"
        configOptions = [
                dateLibrary: 'java8',
                interfaceOnly: 'true',
                skipDefaultInterface: 'true'
        ]
}
// 追加　End
tasks.named('test') {
	useJUnitPlatform()
}

　　③ 出力先と取込元の設定を行う
　　　出力先：

※ 「$rootDir/」は固定で、後ろに作成結果を格納したディレクトリ名を指定する。

　　　取込元：

※ 「$rootDir/」は固定で、後ろにシート「事前準備系」②で用意したフォルダ名と今回対象とするOpenAPIのyamlの名称を指定する。

　　④ 再度、eclipseを開きなおし、Gradleタスクの表示の確認をする。
　　⑤ 一覧の「openapi tools」が表示されていることを確認する。

(8) openApiGenerateの実行

　　① 一覧の「openapi tools」内に、「openApiGenerate」をダブルクリックする。

　　② コンソールに以下のように表示されれれば、実行は成功（エラーの場合、赤文字のトレース分が表示される）

　　③ 出力先に以下のように資材が出力されていた場合、問題なし。

(9) 出力先の確認

　以下の階層でできていることを確認

　　①【ApiUtil.java】

　　②【ShukanTalentJohoBFFApi.java】（Controllerにおいてのメソッドの定義）

　　③【ShukanTalentJohoBFF.java】（Responseのモデル定義）

4.終わりに

この後、Controllerを作る際に、「ShukanTalentJohoBFFApi.java」のメソッドを継承し、
作成することができます。またその中で、「ShukanTalentJohoBFF.java」を参照することでモデルを利用できます。
次回は、「SQLGenerator」について記事を残します。