laravel api

Proyek ujung belakang Laravel/PHP

Tautan ke pembuatan produksi langsung

Selamat datang di salah satu proyek API saya yang lain. Untuk proyek ini, saya telah menulis, menguji, dan menerapkan aplikasi Laravel sebagai bagian dari proyek full-stack, memanfaatkan banyak fitur canggih kerangka ini termasuk:

• fungsi fasad dan pembantu;
• otentikasi dan otorisasi pengguna;
• penyemaian basis data;
• Pembuat kueri ORM yang fasih;
• alat pengujian API tingkat lanjut.

Untuk apa?

API ini memproses data terkait pengguna/kandidat dan ujiannya. Misalnya, memungkinkan pengguna melihat informasi tentang tempat/lokasi ujian, tanggal, nama kandidat, dan lain sebagainya.

Catatan penting tentang akses

• Pastikan Anda menyertakan header HTTP Accept: application/json dengan semua permintaan ke API.
• Sebagian besar fitur API hanya tersedia untuk pengguna tingkat admin. Untuk bereksperimen dengan aplikasi ini, Anda dapat mendaftar akun baru menggunakan email yang diakhiri dengan @v3.admin yang akan memberi Anda hak istimewa admin penuh.

 // 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 "
        }

Setelah Anda mendaftar atau masuk, Anda akan diberikan token API yang perlu dilampirkan ke header permintaan Anda untuk memastikan akses CRUD penuh.

Titik akhir yang tersedia

Untuk mengakses setiap endpint, tambahkan fragmen URI ke root endint. Anda dapat melihat detail lebih lanjut dengan mengunjungi titik akhir root.

Sumber	Keterangan	Otentikasi/otorisasi
POSTING / daftar	Buat akun baru.	Publik
POSTING / masuk	Masuk ke akun yang ada.	Publik
DAPATKAN /logout/{id}	Logout (mencabut token).	Hanya pengguna yang masuk
DAPATKAN /ujian	Menampilkan daftar semua ujian. Termasuk 5 parameter kueri opsional .	Khusus admin
DAPATKAN /ujian/{id}	Dapatkan ujian khusus.	Hanya dapat melihat ujiannya sendiri
PUT /ujian/{id}	Ubah ujian tertentu.	Hanya dapat mengedit ujiannya sendiri
DAPATKAN /ujian/pencarian/{name}	Pencarian substring untuk kandidat tertentu.	Khusus admin
HAPUS /ujian/{id}	Hapus ujian.	Hanya dapat menghapus ujiannya sendiri
DAPATKAN /pengguna	Dapatkan daftar semua pengguna.	Khusus admin
DAPATKAN /pengguna/{id}/ujian	Dapatkan daftar semua ujian untuk pengguna	Hanya dapat melihat ujiannya sendiri

Fitur produk utama

• Diterapkan di Vercel sebagai 'Fungsi Tanpa Server', memanfaatkan runtime PHP untuk menangani konfigurasi aplikasi.
• Penyebaran produksi ditautkan ke database PSQL langsung yang dihosting dari jarak jauh dengan penyedia berbeda.
• Sintaks khusus Laravel yang ekspresif dengan rangkaian metode yang ekstensif, memungkinkan struktur kode yang lebih ringkas.
• Dikembangkan dengan cara yang didorong oleh pengujian menggunakan PHPUnit dan sintaks JSON Laravel yang lancar (berdasarkan penutupan dan kelas AssertableJson).
• Pengujian otomatis dengan alur kerja CI/CD yang dikonfigurasi menggunakan Github Actions.
• Diarsitektur menggunakan pola MVC berorientasi objek
• Layanan otentikasi diimplementasikan menggunakan Sanctum
  • Pengguna dapat mendaftar dan masuk.
  • Rute yang dilindungi hanya dapat diakses oleh pengguna dengan token API yang valid.
• Layanan otorisasi diimplementasikan menggunakan gerbang Laravel, pendekatan otorisasi berbasis penutupan.
  • Tindakan tertentu hanya diperbolehkan untuk pengguna dengan peran tertentu, seperti status admin.
• Batasan hubungan dan skema ditentukan menggunakan alat hubungan Eloquent ORM
• Database SQLite digunakan untuk pengembangan dan pengujian.

File dan folder utama di direktori proyek

• ./app berisi logika inti aplikasi.
  • /app/Http/Controllers berisi logika penanganan permintaan.
  • app/Models berisi semua kelas model dan merupakan tempat kita menentukan semua bidang yang bisa diisi.
  • app/Penyedia berisi kelas yang mem-bootstrap seluruh aplikasi.
• ./routes/api.php adalah tempat kita mendefinisikan secara ringkas semua rute (titik akhir).
• ./tests/Feature berisi semua pengujian integrasi untuk aplikasi.
• ./config/database.php memungkinkan Anda mengonfigurasi pengaturan koneksi database Anda.
• ./database adalah folder lain yang sangat penting.
  • ./database/factories berisi kelas pabrik yang digunakan untuk menyemai database.
  • ./database/migrations memungkinkan kita mengubah model data kita
  • ./databse/seeders berisi kelas-kelas yang menyemai database melalui pabrik.

Menjalankan proyek di lingkungan lokal Anda

Pertama, pastikan Anda telah menginstal PHP dan Komposer di mesin Anda.

Persyaratan versi minimum: PHP ^8.1 ; Komposer 2.5.4 .

1. Fork dan kloning repositori.

2. cd ke dalam repositori dan jalankan perintah CLI ini:

    composer update
    composer install
   

3. Ganti nama file .env.example Anda menjadi .env , hapus variabel untuk koneksi mysql default, dan pastikan Anda menambahkan 3 variabel berikut:

    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. Untuk menjalankan server pengembangan lokal, jalankan perintah Artisan CLI:

    php artisan serve
   

5. Untuk menjalankan test suit, jalankan perintah Artisan CLI:

    php artisan test