使用 Java 和 Spring Boot 为 Postgres 数据库生成 REST API

本教程将向您展示如何使用 monstarillo 为 Postgres 数据库生成 Java API。该 API 将使用 Spring Boot 和 Springdoc 来记录它。该 API 将对您运行它的表执行 CRUD 操作。还将为 API 生成单元测试。
要学习本教程，您将需要：

monstarillo 已安装。
Postgres 数据库 – 我将使用 chinhook 数据库。在 Docker 中设置 Chinhook 示例 Postgres 数据库
Java已安装
Java IDE – 我将使用 InteliJ
吉特

第一步是获取我们将用于生成 API 的模板。为此，请克隆存储库共享模板。我们将使用的模板位于 java-api 文件夹中。
告诉 Monstarillo 将生成的代码放在哪里
接下来，您需要决定将生成的代码放置在哪里。我将通过 Docker 运行 Monstarillo。我将把目录 ~/shared-volume 暴露给运行 Monstarillo 的 docker 镜像。通过克隆存储库创建的共享模板文件夹位于 ~/shared-volume 文件夹中。我将在 ~/shared-volume/code-gen-output 中生成代码。 Monstarillo 在生成代码时会创建 code-gen-output 文件夹。

修改templates.json文件
Monstarillo 使用 json 文件来告诉它要运行哪些模板、如何运行它们以及生成的文件的名称以及将它们放在哪里。我们将修改文件 java-api/postgres/templates.json。 templates.json 文件中的 templates 数组告诉 Monstarillo 要运行哪些模板、如何命名它创建的文件以及将它们放在哪里。 templates.json 文件中的标签数组定义了模板和/或 templates.json 中使用的一些“标签”。例如，PackagePath 在 templates.json 文件中多次使用。 PackagePath 在许多模板中使用，标签允许我们定义一次。要运行模板，您需要修改标签数组中的 TemplateRoot 和 OutputPath 标签。

*TemplateRoot *– 模板根需要指向您克隆的存储库中的 java-api 文件夹。
*OutputPath *– 输出路径需要指向您希望 Monstarillo 放置其生成的文件的文件夹。如果该文件夹尚不存在，Monstarillo 将创建该文件夹。
*PackageBase * – 用于在类中设置包
*ArtifactId * – 在生成的 POM.xml
中使用 *GroupId * – 在生成的 POM.xml
中使用 *ApplicationClassName * – 用作生成的应用程序的主类名称
*ModelPropertySurrondString * – 在为应用程序生成模型的模板中使用。如果您的列名称采用驼峰式大小写，这非常有用。

我在 docker 中运行 Monstarillo，所以我将标签设置为：

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

如果我在本地运行 Monstarillo，我会将标签设置为：

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

运行 Monstarillo 生成代码
接下来我们将构建命令来运行 Monstarillo 来为我们生成代码。我们需要告诉 Monstarillo 我们正在使用 Postgres 数据库并提供连接信息。我们还需要通过传递我们之前设置的 templates.json 文件的位置来告诉 Monstarillo 要运行哪些模板。

要在 docker 中运行 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
</your>

如果我在本地运行 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"
</your>

当您运行命令时，您的输出将类似于：

请注意，Monstarillo 打印出每个表名称及其运行对象。您也许可以使用此信息来解决命令中的错误。

查看您生成的代码
接下来，您可以通过打开您在所选 IDE 中选择的输出目录来查看代码。

接下来，您需要修改生成的代码中的 application.properties 文件以更新数据库连接信息。该文件可以在 src/main/resources/application.properties

找到

在 IntelliJ 中，我将在 IDE 中打开 PersistApi 类并运行它。

我的新 API 正在运行，我可以测试它。我将使用邮递员。我可以通过 http://localhost:8080/album

访问相册控制器

您还可以访问 http://localhost:8080/swagger-ui/index.html 查看生成的代码的 OpenAPI 定义。

注意 src/java/com.monstarillo.persist_api

中生成的单元测试

请在评论中告诉我你的想法

以上是使用 Java 和 Spring Boot 为 Postgres 数据库生成 REST API的详细内容。更多信息请关注PHP中文网其他相关文章！