SpringBootRestAPI

Template Restapi - Spring Boot + MongoDB

Desciption

Templat siap pakai untuk REST API menggunakan spring-boot-microservices, mongoDB sebagai database, terintegrasi dengan codecov dan sonarqube, dapat digunakan untuk cloud. Template ini dapat dicolokkan ke aplikasi apa pun untuk memulai tugas dengan mudah tanpa menulis semuanya dari awal.

Daftar Tugas Kemajuan

• Pengontrol dan model istirahat menggunakan springboot
• Konfigurasi MongoDB
• Travisci Build
• Integrasi Sonarqube
• Laporan Tes Jacoco
• Otentikasi JWT
• 80% dan cakupan kode di atas (menggunakan codecov atau coveralls)
• Penyebaran Cloud

Memulai

• Impor proyek ini ke IDE favorit Anda setelah garpu dan checkout repositori ini.

Langkah Pra-Persyaratan dan Pemasangan

• Dapatkan instance MongoDB yang dapat Anda hubungkan. Untuk informasi lebih lanjut tentang memulai dengan MongoDB, kunjungi tutorial online mereka.

• Mulailah dengan membuat database tes. Saya akan memanggil saya "rest_tutorial" menggunakan perintah berikut di shell mongoDB, atau melalui manajer basis data seperti MongoDB Compass: use rest_tutorial;

• Buat koleksi sampel yang akan menampung data tentang berbagai jenis hewan peliharaan. Mari kita buat koleksi dengan perintah berikut: db.createCollection("pets");

• Setelah koleksi dibuat, kita perlu menambahkan beberapa data! Kami dapat menambahkan data ke koleksi dengan kueri di bawah ini, Anda dapat menambahkan sejumlah data seperti ini: db.pets.insertMany([ { "name" : "Spot", "species" : "dog", "breed" : "pitbull" }, { name": "daisy", "spesies": "name" : "Daisy", "breed" : "calico" }, "name", " "species" : "cat", "Breed": "Calico"} { Name: "CAT": "CAT" }, "name" : "Bella", "species" : "dog", "breed" : "australian shepard" } ]);

• Tambahkan MongoDB Authentication-Database, Username & Password di Application.properties Jika tidak ada otentikasi saat Anda berjalan secara lokal maka Anda juga dapat menghapus properti ini dari file ini.

• Buat peran pengguna dalam database. Peran pengguna bisa menjadi salah satu "pengguna, moderator atau admin"

 db.roles.insertMany([
   { name: "ROLE_USER" },
   { name: "ROLE_MODERATOR" },
   { name: "ROLE_ADMIN" },
])

Menjalankan tes

Setelah server dimulai, Anda harus mendaftarkan pengguna dan login karena pengguna itu untuk mendapatkan token.

Pendaftaran Pengguna

Login pengguna

Setelah Anda mendapatkan token, Anda harus melewati token itu untuk setiap permintaan yang Anda buat ke backend di tukang pos, pilih bagian "header" dan masukkan Authorization untuk kunci dan
"Pembawa" untuk nilainya

Anda bebas menguji API Anda. Gunakan tukang pos untuk tes di bawah ini:

getAllPets

getpetbyid

createPet

Deletepet

MODIFYPETBYID

Setelah selesai dengan semua pengujian, Anda dapat logout menggunakan titik akhir /api/auth/logout

logout

Cakupan Kode

Untuk integrasi laporan cakupan kode, saya telah menunjukkan contoh menggunakan codecov dan coverall karena keduanya cukup populer dan mudah diintegrasikan dengan travis.

• Codecov - cukup tambahkan baris ini di .travis.yml yang akan mengirim laporan Jacoco ke konsol codecov

• CoverAlls - Perlu Menambahkan Plugin Coveralls dan Jacoco Report Path di file build.gradle. Juga perlu perubahan di .travis.yml alih -alih codecov untuk menggunakan coveralls

Template Permintaan Masalah

Are you up for your first Issue Request for this project !!! Luar biasa tapi tolong pertama -tama melalui Template Masalah.md dan gunakan template ini untuk mengirimkan permintaan masalah apa pun.

Template permintaan tarik

Are you up for your first PR for this project !!! Luar biasa tapi silakan pertama -tama melalui Template Permintaan Tarik.md dan gunakan template ini untuk mengirimkan PR Anda.

Berkontribusi

Harap baca Contributing.MD dan Code of Conduct.md untuk perincian tentang kode perilaku kami, dan proses untuk mengirimkan permintaan tarik kepada kami.

Penulis

• Gourav rusiya