Hasilkan API REST Menggunakan Java dan Spring Boot untuk pangkalan data Postgres anda

Tutorial ini akan menunjukkan kepada anda bagaimana anda boleh menjana API Java untuk pangkalan data Postgres anda menggunakan mostarillo. API akan menggunakan Spring Boot dan Springdoc untuk mendokumentasikannya. API akan melaksanakan operasi CRUD pada jadual yang anda lawannya. Ujian unit juga akan dijana untuk API.
Untuk mengikuti tutorial ini, anda memerlukan:

monstarillodipasang.
Pangkalan data Postgres - Saya akan menggunakan pangkalan data chinhook. Sediakan Pangkalan Data Postgres Contoh Chinhook dalam Docker
Java dipasang
IDE Java – Saya akan menggunakan InteliJ
Git

Langkah pertama ialah mendapatkan templat yang akan kami gunakan untuk menjana API kami. Untuk berbuat demikian mengklon templat kongsi repo. Templat yang akan kami gunakan adalah dalam folder java-api.
Beritahu Monstarillo tempat untuk meletakkan kod Dijana
Seterusnya anda perlu memutuskan di mana anda mahu kod yang dihasilkan diletakkan. Saya akan menjalankan Monstarillo melalui Docker. Saya akan mendedahkan direktori ~/shared-volume kepada imej docker yang menjalankan Monstarillo. Folder templat kongsi yang dibuat dengan mengkloning repo berada dalam folder ~/shared-volume. Saya akan menjana kod dalam ~/shared-volume/code-gen-output. Monstarillo akan mencipta folder code-gen-output apabila ia menghasilkan kod.

Ubah suai fail templates.json
Monstarillo menggunakan fail json untuk memberitahu templat yang hendak dijalankan, cara menjalankannya, dan nama fail yang dijananya dan tempat meletakkannya. Kami akan mengubah suai fail java-api/postgres/templates.json. Tatasusunan templat dalam fail templates.json memberitahu Monstarillo templat yang hendak dijalankan, nama untuk fail yang dicipta dan tempat meletakkannya. Tatasusunan tag dalam fail templates.json mentakrifkan beberapa "tag" yang digunakan dalam templat dan/atau templates.json. Contohnya PackagePath digunakan berkali-kali dalam fail templates.json. PackagePath digunakan dalam beberapa templat, teg membolehkan kami mentakrifkannya sekali. Untuk menjalankan templat, anda perlu mengubah suai teg TemplateRoot dan OutputPath dalam tatasusunan teg.

*TemplateRoot *– Akar templat perlu menghala ke folder java-api dalam repositori yang anda klon.
*OutputPath *– Laluan output perlu menghala ke folder yang anda mahu Monstarillo meletakkan fail yang dijananya. Monstarillo akan mencipta folder jika ia belum wujud.
*PackageBase *– Digunakan untuk menetapkan pakej dalam kelas
*ArtifactId *– Digunakan dalam POM.xml yang dihasilkan
*GroupId *– Digunakan dalam POM.xml yang dihasilkan
*ApplicationClassName *– Digunakan sebagai nama kelas utama aplikasi yang dijana
*ModelPropertySurrondString *– Digunakan dalam templat yang menjana model untuk aplikasi. Ini berguna jika nama lajur anda adalah sarung unta.

Saya menjalankan Monstarillo dalam docker jadi saya akan menetapkan tag kepada:

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

Jika saya menjalankan Monstarillo secara tempatan, saya akan menetapkan tag kepada:

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

Jalankan Monstarillo untuk Menjana Kod
Seterusnya kita akan membina arahan untuk menjalankan Monstarillo untuk menjana kod untuk kita. Kami perlu memberitahu Monstarillo bahawa kami menggunakan pangkalan data Postgres dan memberikan maklumat sambungan. Kami juga perlu memberitahu Monstarillo templat yang hendak dijalankan dengan menghantar lokasi fail templates.json yang kami sediakan sebelum ini.

Untuk menjalankan Monstarillo dalam docker arahan kami akan kelihatan serupa dengan:

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

Jika saya menjalankan Monstarillo secara tempatan, arahan saya ialah:

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"

Apabila anda menjalankan perintah output anda akan serupa dengan:

Perhatikan bahawa Monstarillo mencetak setiap nama jadual dan ia bertentangan. Anda mungkin boleh menggunakan maklumat ini untuk menyelesaikan ralat dalam arahan anda.

Lihat Kod Dijana Anda
Seterusnya anda boleh melihat kod anda dengan membuka direktori output yang anda pilih dalam IDE pilihan anda.

Seterusnya anda perlu mengubah suai fail application.properties dalam kod yang anda hasilkan untuk mengemas kini maklumat sambungan pangkalan data anda. Fail boleh didapati di src/main/resources/application.properties

Dalam IntelliJ saya akan membuka kelas PersistApi dalam IDE dan menjalankannya.

API baharu saya sedang berjalan dan saya boleh mengujinya. Saya akan menggunakan Posmen. Saya boleh mengakses pengawal album di http://localhost:8080/album

Anda juga boleh melayari http://localhost:8080/swagger-ui/index.html untuk melihat definisi OpenAPI yang dijana untuk kod yang dijana.

Perhatikan ujian unit yang telah dijana dalam src/java/com.monstarillo.persist_api

Beri tahu saya pendapat anda dalam ulasan

Atas ialah kandungan terperinci Hasilkan API REST Menggunakan Java dan Spring Boot untuk pangkalan data Postgres anda. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!