Buat projek Laravel baru dan mulakan perkhidmatan; 2. Menjana model, penghijrahan dan pengawal dan jalankan penghijrahan; 3. Tentukan laluan RESTful dalam Laluan/API.PHP; 4. Melaksanakan kaedah tambahan, penghapusan, pengubahsuaian dan pertanyaan dalam postcontroller dan mengembalikan respons JSON; 5. Uji fungsi API dengan Postman atau Curl; 6. Pilihan menambah pengesahan API melalui Sanctum; Akhirnya dapatkan struktur yang jelas, API Laravel REST yang lengkap dan boleh diperpanjang sesuai untuk aplikasi praktikal.

Membina API REST dengan Laravel adalah terima kasih kepada ciri-ciri terbina dalam untuk penghalaan, fasih Orm, dan pengendalian permintaan. Berikut adalah panduan praktikal untuk membantu anda membuat API REST yang bersih dan berfungsi menggunakan Laravel.

1. Sediakan projek Laravel baru

Mulakan dengan membuat projek Laravel baru menggunakan komposer:

 Komposer membuat projek Laravel/Laravel API-Demo
CD API-Demo

Kemudian, mulakan pelayan pembangunan untuk mengesahkan semuanya berfungsi:

 PHP Artisan berkhidmat

Anda harus melihat halaman Selamat Datang Laravel di http://localhost:8000 .

2. Buat model, penghijrahan, dan pengawal

Mari kita bina API mudah untuk menguruskan jawatan . Gunakan perintah make:model -a untuk menghasilkan model, penghijrahan, kilang, dan pengawal:

 PHP Artisan Make: Model Post -A

Ini mencipta:

• app/Models/Post.php - Model Fasih
• database/migrations/xxxx_create_posts_table.php - penghijrahan
• app/Http/Controllers/PostController.php - Pengawal
• database/factories/PostFactory.php - untuk melihat

Edit fail penghijrahan untuk menentukan medan pos:

 // dalam pangkalan data/migrasi /..._ create_posts_table.php
Skema :: Create ('Posts', Function (Blueprint $ Table) {
    $ Table-> id ();
    $ Table-> String ('Tajuk');
    $ Table-> Text ('Body');
    $ Table-> Timestamps ();
});

Jalankan penghijrahan:

 PHP Artisan berhijrah

3. Tentukan laluan API

Buka routes/api.php dan tentukan laluan yang tenang menggunakan Route::apiResource() :

 Gunakan App \ Http \ Controllers \ PostController;

Route :: ApireSource ('Posts', PostController :: Class);

Laluan ini secara automatik memetakan tindakan rehat standard:

• GET /api/posts → Indeks
• POST /api/posts → Simpan
• GET /api/posts/{id} → Tunjukkan
• PUT/PATCH /api/posts/{id} → kemas kini
• DELETE /api/posts/{id} → Destroy

Anda boleh melihat semua laluan dengan:

 Laluan Artisan PHP: Senarai --Path = API

4. Melaksanakan kaedah pengawal

Buka app/Http/Controllers/PostController.php dan isi logik menggunakan fasih.

 Gunakan App \ Models \ Post;
Gunakan Illuminate \ http \ request;

PostController Kelas Memperluas Pengawal
{
    Indeks Fungsi Awam ()
    {
        respons balik ()-> json (post :: all ());
    }

    Kedai Fungsi Awam (permintaan $ permintaan)
    {
        $ disahkan = $ permintaan-> validate ([
            'Tajuk' => 'Diperlukan | String | Max: 255',
            'badan' => 'diperlukan | rentetan',
        ]);

        $ pos = pos :: create ($ disahkan);

        tindak balas kembali ()-> json ($ post, 201);
    }

    Pertunjukan Fungsi Awam ($ ID)
    {
        $ pos = pos :: cari ($ id);

        jika (! $ post) {
            REBATION RESPONSE ()-> JSON (['MESSAGE' => 'POST TIDAK DIPERLUKAN'], 404);
        }

        tindak balas kembali ()-> json ($ pos);
    }

    Kemas kini Fungsi Awam (permintaan $ permintaan, $ id)
    {
        $ pos = pos :: cari ($ id);

        jika (! $ post) {
            REBATION RESPONSE ()-> JSON (['MESSAGE' => 'POST TIDAK DIPERLUKAN'], 404);
        }

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

        $ post-> kemas kini ($ disahkan);

        tindak balas kembali ()-> json ($ pos);
    }

    Fungsi awam memusnahkan ($ id)
    {
        $ pos = pos :: cari ($ id);

        jika (! $ post) {
            REBATION RESPONSE ()-> JSON (['MESSAGE' => 'POST TIDAK DIPERLUKAN'], 404);
        }

        $ post-> padam ();

        respons balik ()-> json (['message' => 'post dipadam']);
    }
}

? Laravel secara automatik mengembalikan respons JSON apabila anda lulus data ke response()->json() . Juga, laluan API sudah dilindungi oleh bukti CSRF dan menggunakan middleware api (tanpa stat).

5. Uji API

Gunakan alat seperti Postman , Curl , atau Thunder Client (VS Code) untuk menguji titik akhir anda.

Contoh: Buat siaran dengan curl

 curl -x post http: // localhost: 8000/api/post \
  -H "jenis kandungan: aplikasi/json" \
  -d '{"tajuk": "jawatan pertama saya", "badan": "Ini badan"}'

Anda harus mendapatkan respons JSON dengan jawatan yang dibuat dan status 201 .

6. (Pilihan) Tambahkan Pengesahan API dengan Sanctum

Untuk laluan yang dilindungi, gunakan Sanctum Laravel untuk menambah pengesahan berasaskan token.

Pasang Sanctum:

 Komposer memerlukan laravel/sanctum
PHP Artisan Vendor: Terbitkan --Provider = "Laravel \ Sanctum \ SanctumserviceProvider"
PHP Artisan berhijrah

Tambah middleware sanctum dalam app/Http/Kernel.php di bawah 'api' :

 'api' => [
    \ Laravel \ sanctum \ http \ middleware \ memastikanfrontendrequestsarestatence :: class,
    'Throttle: Api',
    \ Illuminate \ routing \ middleware \ penggantianbinding :: kelas,
],

Lindungi Laluan Anda:

 Laluan :: Middleware ('Auth: Sanctum')-> Apiresource ('Posts', PostController :: Class);

Sekarang pengguna mesti mengesahkan dengan token untuk mengakses API.

Nota akhir

• Pastikan Logik Pengesahan Bersih -Mengambil alih Menggunakan Permintaan Borang Untuk Peraturan Kompleks.
• Gunakan sumber API ( php artisan make:resource PostResource ) untuk memformat respons.
• Sentiasa mengendalikan kesilapan dengan anggun (contohnya, 404, 422).
• Gunakan versi (contohnya, /api/v1/posts ) untuk kestabilan jangka panjang.

Itu sahaja. Anda kini mempunyai API REST berfungsi sepenuhnya dengan Laravel. Ia bersih, berskala, dan bersedia untuk kegunaan dunia sebenar.

Atas ialah kandungan terperinci Bagaimana membina API REST dengan Laravel?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!