本教程將向您展示如何使用 monstarillo 為 Postgres 數(shù)據(jù)庫(kù)生成 Java API。該 API 將使用 Spring Boot 和 Springdoc 來(lái)記錄它。該 API 將對(duì)您運(yùn)行它的表執(zhí)行 CRUD 操作。還將為 API 生成單元測(cè)試。
要學(xué)習(xí)本教程，您將需要：

monstarillo 已安裝。
Postgres 數(shù)據(jù)庫(kù) – 我將使用 chinhook 數(shù)據(jù)庫(kù)。在 Docker 中設(shè)置 Chinhook 示例 Postgres 數(shù)據(jù)庫(kù)
Java已安裝
Java IDE – 我將使用 InteliJ
吉特

第一步是獲取我們將用于生成 API 的模板。為此，請(qǐng)克隆存儲(chǔ)庫(kù)共享模板。我們將使用的模板位于 java-api 文件夾中。
告訴 Monstarillo 將生成的代碼放在哪里
接下來(lái)，您需要決定將生成的代碼放置在哪里。我將通過 Docker 運(yùn)行 Monstarillo。我將把目錄 ~/shared-volume 暴露給運(yùn)行 Monstarillo 的 docker 鏡像。通過克隆存儲(chǔ)庫(kù)創(chuàng)建的共享模板文件夾位于 ~/shared-volume 文件夾中。我將在 ~/shared-volume/code-gen-output 中生成代碼。 Monstarillo 在生成代碼時(shí)會(huì)創(chuàng)建 code-gen-output 文件夾。

修改templates.json文件
Monstarillo 使用 json 文件來(lái)告訴它要運(yùn)行哪些模板、如何運(yùn)行它們以及生成的文件的名稱以及將它們放在哪里。我們將修改文件 java-api/postgres/templates.json。 templates.json 文件中的 templates 數(shù)組告訴 Monstarillo 要運(yùn)行哪些模板、如何命名它創(chuàng)建的文件以及將它們放在哪里。 templates.json 文件中的標(biāo)簽數(shù)組定義了模板和/或 templates.json 中使用的一些“標(biāo)簽”。例如，PackagePath 在 templates.json 文件中多次使用。 PackagePath 在許多模板中使用，標(biāo)簽允許我們定義一次。要運(yùn)行模板，您需要修改標(biāo)簽數(shù)組中的 TemplateRoot 和 OutputPath 標(biāo)簽。

*TemplateRoot *– 模板根需要指向您克隆的存儲(chǔ)庫(kù)中的 java-api 文件夾。
*OutputPath *– 輸出路徑需要指向您希望 Monstarillo 放置其生成的文件的文件夾。如果該文件夾尚不存在，Monstarillo 將創(chuàng)建該文件夾。
*PackageBase * – 用于在類中設(shè)置包
*ArtifactId * – 在生成的 POM.xml
中使用 *GroupId * – 在生成的 POM.xml
中使用 *ApplicationClassName * – 用作生成的應(yīng)用程序的主類名稱
*ModelPropertySurrondString * – 在為應(yīng)用程序生成模型的模板中使用。如果您的列名稱采用駝峰式大小寫，這非常有用。

我在 docker 中運(yùn)行 Monstarillo，所以我將標(biāo)簽設(shè)置為：

{
   "tagName": "TemplateRoot",
   "value": "/usr/local/monstarillo/shared-templates/java-api"
},
{
   "tagName": "OutputPath",
   "value": "/usr/local/monstarillo/code-gen-output/java-01"
}

如果我在本地運(yùn)行 Monstarillo，我會(huì)將標(biāo)簽設(shè)置為：

{
   "tagName": "TemplateRoot",
   "value": "/home/patrick/code/patrick-templates/java-api"
},
{
   "tagName": "OutputPath",
   "value": "/home/patrick/code-gen-output/java-01"
}

運(yùn)行 Monstarillo 生成代碼
接下來(lái)我們將構(gòu)建命令來(lái)運(yùn)行 Monstarillo 來(lái)為我們生成代碼。我們需要告訴 Monstarillo 我們正在使用 Postgres 數(shù)據(jù)庫(kù)并提供連接信息。我們還需要通過傳遞我們之前設(shè)置的 templates.json 文件的位置來(lái)告訴 Monstarillo 要運(yùn)行哪些模板。

要在 docker 中運(yùn)行 Monstarillo，我們的命令將類似于：

docker run --volume=/mnt/c/code:/usr/local/monstarillo \
--network=host \
monstarillo/monstarillo:latest postgres \
--t /usr/local/monstarillo/shared-templates/java-api/postgres/templates.json  \
--u postgres \
--p <Your Database Password> \
--db "chinhook-db" \
--host "localhost" \
--schema "public"
In this command I am mounting /mnt/c/code to the docker image as /usr/local/monstarillo that is running monstarillo. My shared-templates folder is at /mnt/c/code/shared-templates and will be generating code to /mnt/c/code/code-gen-output/java-01

如果我在本地運(yùn)行 Monstarillo，我的命令將是：

monstarillo postgres \
--t /home/patrick/code/patricks-monstarillo-templates/java-api/templates.json  \
--u postgres \
--p <Your Database Password>\
--db "chinhook-db" \
--host "localhost" \
--schema "public"

當(dāng)您運(yùn)行命令時(shí)，您的輸出將類似于：

請(qǐng)注意，Monstarillo 打印出每個(gè)表名稱及其運(yùn)行對(duì)象。您也許可以使用此信息來(lái)解決命令中的錯(cuò)誤。

查看您生成的代碼
接下來(lái)，您可以通過打開您在所選 IDE 中選擇的輸出目錄來(lái)查看代碼。

接下來(lái)，您需要修改生成的代碼中的 application.properties 文件以更新數(shù)據(jù)庫(kù)連接信息。該文件可以在 src/main/resources/application.properties

找到

在 IntelliJ 中，我將在 IDE 中打開 PersistApi 類并運(yùn)行它。

我的新 API 正在運(yùn)行，我可以測(cè)試它。我將使用郵遞員。我可以通過 http://localhost:8080/album

訪問相冊(cè)控制器

您還可以訪問 http://localhost:8080/swagger-ui/index.html 查看生成的代碼的 OpenAPI 定義。

注意 src/java/com.monstarillo.persist_api

中生成的單元測(cè)試

請(qǐng)?jiān)谠u(píng)論中告訴我你的想法

以上是使用 Java 和 Spring Boot 為 Postgres 數(shù)據(jù)庫(kù)生成 REST API的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！