หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>หลาม
ดาวน์โหลด

โครงการแบ็คเอนด์ Laravel / PHP

ลิงก์ไปยังบิลด์การผลิตแบบสด

ยินดีต้อนรับสู่อีกหนึ่งโครงการ API ของฉัน สำหรับโปรเจ็กต์นี้ ฉันได้เขียน ทดสอบ และปรับใช้แอปพลิเคชัน Laravel โดยเป็นส่วนหนึ่งของโปรเจ็กต์ฟูลสแตก โดยใช้ประโยชน์จากฟีเจอร์อันทรงพลังมากมายของเฟรมเวิร์ก รวมถึง:

  • ฟังก์ชั่นด้านหน้าและผู้ช่วย
  • การรับรองความถูกต้องและการอนุญาตผู้ใช้
  • การเพาะฐานข้อมูล
  • ตัวสร้างแบบสอบถาม Eloquent ORM;
  • เครื่องมือทดสอบ API ขั้นสูง

มีไว้เพื่ออะไร?

API นี้ประมวลผลข้อมูลที่เกี่ยวข้องกับผู้ใช้/ผู้สมัครและการสอบของพวกเขา ตัวอย่างเช่น อนุญาตให้ผู้ใช้ดูข้อมูลเกี่ยวกับสถานที่สอบ/สถานที่สอบ วันที่ ชื่อผู้สมัคร และอื่นๆ

หมายเหตุสำคัญเกี่ยวกับการเข้าถึง

  • ตรวจสอบให้แน่ใจว่าคุณได้รวมส่วนหัว Accept: application/json HTTP พร้อมกับคำขอทั้งหมดไปยัง API
  • คุณสมบัติส่วนใหญ่ของ API มีให้สำหรับผู้ใช้ระดับผู้ดูแลระบบเท่านั้น หากต้องการทดลองใช้แอปนี้ คุณสามารถสมัครบัญชีใหม่โดยใช้อีเมลที่ลงท้ายด้วย @v3.admin ซึ่งจะให้สิทธิ์ผู้ดูแลระบบเต็มรูปแบบแก่คุณ 
 // To sign up as an admin, make a POST request to https://laravel-php-api.vercel.app/public/api/signup and include a request body in the following format:

        {
		    "name" : " Anna Torpid " ,
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf " ,
		    "password_confirmation" : " dfbdf9suhfd9shf "
        }

// To login, make a POST request to https://laravel-php-api.vercel.app/public/api/login and include a request body in the following format:

        {
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf "
        }

// The above POST request returns this response. Make sure to include the returned token in the authorisation header of all future requests.

        {
	        "user" : {
		        "id" : 11 ,
		        "name" : " Anna Torpid " ,
		        "email" : " [email protected] "
	        },
	        "token" : " 5|tAujbY9luWTKquNEruGHU7soCXp7MuzVb8WR0VO9 "
        }

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

ปลายทางที่มีอยู่

หากต้องการเข้าถึงส่วนปลายแต่ละส่วน ให้เพิ่มส่วน URI เข้ากับส่วนปลายราก คุณสามารถดูรายละเอียดเพิ่มเติมได้โดยไปที่จุดสิ้นสุดรูท

ทรัพยากร คำอธิบาย การรับรองความถูกต้อง/การอนุญาต
โพสต์ / สมัครสมาชิก สร้างบัญชีใหม่ สาธารณะ
โพสต์ /เข้าสู่ระบบ เข้าสู่ระบบบัญชีที่มีอยู่ สาธารณะ
รับ /ออกจากระบบ/{id} ออกจากระบบ (เพิกถอนโทเค็น) ผู้ใช้ที่เข้าสู่ระบบเท่านั้น
รับ/สอบ แสดงรายการข้อสอบทั้งหมด รวมพารามิเตอร์การค้นหาเพิ่มเติม 5 รายการ ผู้ดูแลระบบเท่านั้น
รับ / สอบ / {id} รับสอบเฉพาะทาง. ดูได้เฉพาะข้อสอบของตัวเองเท่านั้น
PUT /การสอบ/{id} ปรับเปลี่ยนข้อสอบเฉพาะ แก้ไขได้เฉพาะข้อสอบของตนเองเท่านั้น
รับ / สอบ / ค้นหา / {ชื่อ} ค้นหาสตริงย่อยสำหรับผู้สมัครที่เฉพาะเจาะจง ผู้ดูแลระบบเท่านั้น
ลบ /การสอบ/{id} ลบข้อสอบ. ลบได้เฉพาะข้อสอบของตนเองเท่านั้น
รับ / ผู้ใช้ รับรายชื่อผู้ใช้ทั้งหมด ผู้ดูแลระบบเท่านั้น
GET /users/{id}/exams รับรายการสอบทั้งหมดสำหรับผู้ใช้ ดูได้เฉพาะข้อสอบของตัวเองเท่านั้น

คุณสมบัติที่สำคัญของผลิตภัณฑ์

  • ปรับใช้บน Vercel ในรูปแบบ 'ฟังก์ชันไร้เซิร์ฟเวอร์' โดยใช้รันไทม์ PHP เพื่อจัดการการกำหนดค่าของแอปพลิเคชัน
  • การใช้งานจริงจะเชื่อมโยงกับฐานข้อมูล PSQL แบบสดที่โฮสต์จากระยะไกลกับผู้ให้บริการรายอื่น
  • ไวยากรณ์เฉพาะของ Laravel ที่แสดงออกพร้อมการผูกมัดวิธีการที่ครอบคลุม ช่วยให้มีโครงสร้างโค้ดที่กระชับยิ่งขึ้น
  • พัฒนาในลักษณะที่ขับเคลื่อนด้วยการทดสอบโดยใช้ PHPUnit และไวยากรณ์ JSON ได้อย่างคล่องแคล่วของ Laravel (ขึ้นอยู่กับการปิดและคลาส AssertableJson)
  • การทดสอบอัตโนมัติด้วยเวิร์กโฟลว์ CI/CD ที่กำหนดค่าโดยใช้ Github Actions
  • ออกแบบโดยใช้รูปแบบ MVC เชิงวัตถุ
  • บริการตรวจสอบความถูกต้องดำเนินการโดยใช้ Sanctum
    • ผู้ใช้สามารถลงทะเบียนและเข้าสู่ระบบได้
    • เส้นทางที่ได้รับการป้องกันสามารถเข้าถึงได้เฉพาะผู้ใช้ที่มีโทเค็น API ที่ถูกต้องเท่านั้น
  • บริการอนุญาตดำเนินการโดยใช้ประตูของ Laravel ซึ่งเป็นวิธีการปิดเพื่ออนุญาต
    • การดำเนินการบางอย่างจะได้รับอนุญาตเฉพาะกับผู้ใช้ที่มีบทบาทเฉพาะ เช่น สถานะผู้ดูแลระบบ
  • ความสัมพันธ์และข้อจำกัดของสคีมาที่กำหนดโดยใช้เครื่องมือความสัมพันธ์ของ Eloquent ORM
  • ฐานข้อมูล SQLite ที่ใช้สำหรับการพัฒนาและการทดสอบ

ไฟล์และโฟลเดอร์หลักในไดเร็กทอรีโครงการ

  • ./app มีตรรกะหลักของแอปพลิเคชัน
    • /app/Http/Controllers มีตรรกะการจัดการคำขอ
    • app/Models มีคลาสโมเดลทั้งหมดและเป็นตำแหน่งที่เราระบุฟิลด์ที่กรอกได้ทั้งหมด
    • app/Providers มีคลาสที่บูตแอปพลิเคชันทั้งหมด
  • ./routes/api.php เป็นที่ที่เรากำหนดเส้นทาง (จุดสิ้นสุด) ทั้งหมดของเราอย่างกระชับ
  • ./tests/Feature มีการทดสอบการรวมทั้งหมดสำหรับแอป
  • ./config/database.php ช่วยให้คุณสามารถกำหนดการตั้งค่าการเชื่อมต่อฐานข้อมูลของคุณได้
  • ./database เป็นอีกโฟลเดอร์ที่สำคัญมาก
    • ./database/factory มีคลาสโรงงานที่ใช้ในการเพาะฐานข้อมูล
    • ./database/migrations ช่วยให้เราสามารถแก้ไขโมเดลข้อมูลของเราได้
    • ./databse/seeders มีคลาสที่เพาะฐานข้อมูลผ่านโรงงาน

ดำเนินโครงการในสภาพแวดล้อมท้องถิ่นของคุณ

ขั้นแรก ตรวจสอบให้แน่ใจว่าคุณได้ติดตั้ง PHP และ Composer ไว้ในเครื่องของคุณแล้ว

ข้อกำหนดเวอร์ชันขั้นต่ำ: PHP ^8.1 ; ผู้แต่ง 2.5.4 .

  1. แยกและโคลนพื้นที่เก็บข้อมูล

  2. cd ลงในที่เก็บและรันคำสั่ง CLI เหล่านี้: 

     composer update
 composer install

  3. เปลี่ยนชื่อไฟล์ .env.example ของคุณเป็น .env ลบตัวแปรสำหรับการเชื่อมต่อ mysql เริ่มต้น และให้แน่ใจว่าคุณเพิ่มตัวแปร 3 ตัวต่อไปนี้: 

     DB_CONNECTION=sqlite
 DB_FOREIGN_KEYS=true
 USE_SQLITE_SYNTAX=like
 DB_DATABASE= this needs to be the absolute path to the sqlite database located in ./database/database.sqlite, e.g. /home/username/mydocuments/laravel-api/database/database.sqlite*

  4. หากต้องการหมุนเซิร์ฟเวอร์การพัฒนาในเครื่อง ให้รันคำสั่ง Artisan CLI: 

     php artisan serve

  5. หากต้องการรันชุดทดสอบ ให้รันคำสั่ง Artisan CLI: 

     php artisan test

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด