ดาวน์โหลด SpringBootRestAPI - แหล่งข้อมูล SpringBootRestAPI ดาวน์โหลด

SpringBootRestAPI

ซอร์สโค้ดอื่น ๆ

1.0.0

ดาวน์โหลด

เทมเพลต Restapi - Spring Boot + MongoDB

การสืบทอด

เทมเพลตพร้อมใช้งานสำหรับ REST API โดยใช้ Spring-Boot-Microservices, MongoDB เป็นฐานข้อมูลที่รวมเข้ากับ Codecov และ Sonarqube ซึ่งสามารถใช้งานได้กับคลาวด์ เทมเพลตนี้สามารถเสียบเข้ากับแอปพลิเคชันใด ๆ เพื่อเริ่มงานได้อย่างง่ายดายโดยไม่ต้องเขียนทุกอย่างตั้งแต่เริ่มต้น

รายการงานคืบหน้า

ตัวควบคุมที่เหลือและรุ่นโดยใช้ Springboot
การกำหนดค่า MongoDB
Travisci Build
การรวม Sonarqube
รายงานการทดสอบ Jacoco
การรับรองความถูกต้องของ JWT
80% และสูงกว่าการครอบคลุมรหัส (ใช้ codecov หรือ coveralls)
การปรับใช้คลาวด์

เริ่มต้น

นำเข้าโครงการนี้ไปยัง IDE ที่คุณชื่นชอบหลังจากส้อมและเช็คเอาต์ของที่เก็บนี้

สิ่งที่ต้องใช้ล่วงหน้าและขั้นตอนการติดตั้ง

รับอินสแตนซ์ของ MongoDB ที่คุณสามารถเชื่อมต่อได้ สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการเริ่มต้นใช้งาน MongoDB เยี่ยมชมการสอนออนไลน์ของพวกเขา
เริ่มต้นด้วยการสร้างฐานข้อมูลทดสอบ ฉันจะเรียกฉันว่า "REST_TUTORIAL" โดยใช้คำสั่งต่อไปนี้ในเชลล์ MongoDB หรือผ่านตัวจัดการฐานข้อมูลเช่น MongoDB Compass: use rest_tutorial;
สร้างคอลเลกชันตัวอย่างที่จะเก็บข้อมูลเกี่ยวกับสัตว์เลี้ยงประเภทต่างๆ มาสร้างคอลเลกชันด้วยคำสั่งต่อไปนี้: db.createCollection("pets");
เมื่อรวบรวมคอลเลกชันเราต้องเพิ่มข้อมูลบางอย่าง! เราสามารถเพิ่มข้อมูลลงในคอลเล็กชันด้วยแบบสอบถามด้านล่างคุณสามารถเพิ่มข้อมูลจำนวนนี้ได้เช่นนี้: db.pets.insertMany([ { "name" : "Spot", "name" : "Daisy", ชีส์": "species" : "cat", "species" : "dog", "breed" : "calico" "breed" : "pitbull" }, }, { { "name" : "Bella", "species" : "dog", "breed" : "australian shepard" } ]);
เพิ่ม MongoDB Authentication-Database ชื่อผู้ใช้และรหัสผ่านในแอปพลิเคชัน properties หากไม่มีการรับรองความถูกต้องเมื่อคุณใช้งานในเครื่องนั้นคุณสามารถลบคุณสมบัติเหล่านี้ออกจากไฟล์นี้ได้
สร้างบทบาทผู้ใช้ในฐานข้อมูล บทบาทของผู้ใช้สามารถเป็นหนึ่งใน "ผู้ใช้ผู้ดูแลหรือผู้ดูแลระบบ"

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

รันการทดสอบ

เมื่อเซิร์ฟเวอร์เริ่มต้นคุณต้องลงทะเบียนผู้ใช้และเข้าสู่ระบบเป็นครั้งแรกในฐานะผู้ใช้รายนั้นเพื่อรับโทเค็น

การลงทะเบียนผู้ใช้

เข้าสู่ระบบผู้ใช้

เมื่อคุณได้รับโทเค็นคุณจะต้องส่งโทเค็นนั้นสำหรับทุกคำขอที่คุณทำกับแบ็กเอนด์ในบุรุษไปรษณีย์เลือกส่วน "ส่วนหัว" และป้อน Authorization สำหรับคีย์และ
"ผู้ถือ" สำหรับค่า

คุณมีอิสระที่จะทดสอบ API ของคุณตามที่คุณเลือก ใช้บุรุษไปรษณีย์สำหรับการทดสอบด้านล่าง:

getAllpets

getPetbyid

createpet

การลบ

ModifyPetById

เมื่อเสร็จสิ้นกับการทดสอบทั้งหมดคุณสามารถออกจากระบบโดยใช้จุดสิ้นสุด /api/auth/logout

ออกจากระบบ

ความครอบคลุมของรหัส

สำหรับการรวมรายงานการครอบคลุมรหัสฉันได้แสดงตัวอย่างโดยใช้ codecov และ coveralls เนื่องจากทั้งคู่ค่อนข้างเป็นที่นิยมและง่ายต่อการรวมเข้ากับเทรวิส

codecov - เพียงเพิ่มบรรทัดนี้ใน. travis.yml ซึ่งจะส่งรายงาน Jacoco ไปยังคอนโซล codecov
CoverAlls - จำเป็นต้องเพิ่มปลั๊กอิน Coveralls และเส้นทางรายงาน Jacoco ในไฟล์ build.gradle ยังต้องการการเปลี่ยนแปลงใน. travis.yml แทน codecov เพื่อใช้ coveralls