Untuk membina API RESTful yang mantap di Laravel, gunakan pengawal sumber untuk operasi CRUD, versi titik akhir anda, mengembalikan respons JSON yang konsisten, mengesahkan input awal, dan mengendalikan pengecualian di seluruh dunia. Pertama, menjana pengawal sumber dan tentukan laluan dengan kata nama jamak dan kata kerja HTTP untuk konsistensi. Kedua, laluan kumpulan di bawah awalan versi seperti/API/V1/jawatan untuk memastikan keserasian ke belakang. Ketiga, struktur semua respons dengan format seragam termasuk bidang kejayaan, data, dan mesej menggunakan pembantu respons Laravel. Keempat, sahkan input menggunakan permintaan borang atau pengesahan sebaris untuk mengelakkan data yang buruk. Akhirnya, mengendalikan pengecualian secara global melalui APP \ Exceptions \ Handler untuk mengembalikan respons ralat berstruktur.

Apabila membina API yang tenang dengan Laravel, matlamatnya adalah untuk mencipta sesuatu yang bukan hanya berfungsi tetapi juga berskala, boleh dikekalkan, dan selamat. Laravel memberi anda asas yang kukuh dari kotak, tetapi mengetahui cara menyusun kod anda dan memanfaatkan ciri -cirinya dengan betul membuat semua perbezaan.

Gunakan pengawal sumber dan konvensyen penamaan laluan

Pengawal sumber Laravel adalah sempurna untuk operasi CRUD standard. Mereka menguatkuasakan struktur URL yang konsisten dan mengurangkan boilerplate dengan memetakan laluan secara automatik.

• Jalankan php artisan make:controller PostController --resource untuk menghasilkan pengawal dengan semua kaedah standard.
• Tentukan laluan menggunakan Route::resource('posts', PostController::class);
• Melekat pada kata nama majmuk dalam URL anda ( /api/posts , /api/comments ) dan gunakan kata kerja HTTP untuk menunjukkan tindakan (mendapatkan, pos, letakkan, padam).

Pendekatan ini menjadikan API anda dapat diramalkan dan lebih mudah bagi orang lain untuk memahami atau mengintegrasikan dengan.

Versi titik akhir API anda

API sering berubah dari masa ke masa, dan memecahkan perubahan boleh menyebabkan masalah bagi pelanggan sedia ada. Itulah sebabnya penting untuk versi API anda dari hari ke hari.

• Susun laluan di bawah awalan versi seperti /api/v1/posts
• Anda boleh melakukan ini dengan mengumpulkan laluan:

 Route :: awalan ('v1')-> kumpulan (fungsi () {
    Route :: ApireSource ('Posts', PostController :: Class);
});

Ini membolehkan anda memperkenalkan titik akhir baru tanpa menjejaskan yang sedia ada. Sekiranya anda perlu mengubah tingkah laku dengan ketara, buat versi baru dan bukannya mengubah suai yang lama.

Kembalikan struktur JSON yang konsisten

Konsistensi dalam respons API anda membantu pelanggan menghuraikan data lebih dipercayai dan mengendalikan kesilapan dengan anggun.

Daripada mengembalikan data mentah seperti:

 kembali ['data' => $ posts];

Buat format standard di seluruh aplikasi anda:

 {
  "Kejayaan": Benar,
  "data": {...},
  "Mesej": "Catatan yang Diperolehi"
}

Anda boleh membina fungsi pembantu atau menggunakan response() penolong untuk membungkus pulangan anda:

 REBUND RESPONE ()-> JSON ([
    'Kejayaan' => Benar,
    'Data' => $ posts,
    'Mesej' => 'Catatan Diperolehi'
]);

Untuk kesilapan, kembalikan kod status yang sesuai dan masukkan medan mesej supaya pelanggan tahu apa yang salah.

Mengesahkan input awal dan jelas

Jangan sekali -kali mempercayai data masuk - selalu mengesahkannya sebelum meneruskan. Laravel menyediakan alat pengesahan yang kuat yang menjadikan logik anda bersih.

Gunakan permintaan borang untuk pengesahan kompleks:

 PHP Artisan Make: Permintaan StorePostrequest

Kemudian dalam kaedah pengawal anda:

 Kedai Fungsi Awam (StorePostrequest $ permintaan)
{
    // Pengesahan diluluskan, teruskan
}

Atau untuk kes yang lebih mudah, gunakan pengesahan sebaris:

 $ permintaan-> validate ([
    'Tajuk' => 'Diperlukan | String | Max: 255',
    'kandungan' => 'diperlukan'
]);

Jika pengesahan gagal, Laravel akan mengembalikan ralat 422 dengan mesej terperinci - tidak perlu menyemak setiap bidang secara manual.

Juga, pastikan untuk menangkap dan memformat sebarang pengecualian secara global menggunakan App\Exceptions\Handler . Ini memastikan isu -isu yang tidak dijangka mengembalikan tindak balas JSON berstruktur.

Itulah pada dasarnya bagaimana anda menyediakan API Restful yang kukuh di Laravel. Ia tidak rumit, tetapi mendapatkan asas -asas ini menjimatkan anda dari banyak sakit kepala kemudian.

Atas ialah kandungan terperinci Cara Membina API Restful yang kuat Menggunakan Laravel. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!