Bagaimana untuk menulis laravel api

Dengan pembangunan aplikasi Internet dan aplikasi mudah alih, banyak syarikat dan pembangun telah mula menggunakan seni bina pemisah bahagian hadapan dan bahagian belakang menyediakan API RESTful untuk digunakan di bahagian hadapan API dengan cepat dan cekap telah menjadi kebimbangan ramai pembangun. Laravel ialah rangka kerja web PHP popular yang menyediakan penghalaan lengkap, ORM, perisian tengah dan komponen lain, menjadikannya sangat mudah untuk menulis API. Artikel ini akan meneroka cara menulis API RESTful dalam rangka kerja Laravel.

1. Memasang dan mengkonfigurasi rangka kerja Laravel

Mula-mula anda perlu memasang rangka kerja Laravel, yang boleh dimuat turun melalui laman web rasmi Laravel atau komposer:

composer create-project --prefer-dist laravel/laravel api

Kemudian konfigurasikannya Anda boleh mengkonfigurasi pangkalan data, cache, baris gilir dan komponen lain dalam fail .env. Untuk kemudahan, anda boleh mengkonfigurasi maklumat pangkalan data dalam fail .env:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=api
DB_USERNAME=root
DB_PASSWORD=

dan menambah maklumat pangkalan data dalam fail config/database.php:

'mysql' => [
    'driver' => 'mysql',
    'host' => env('DB_HOST', '127.0.0.1'),
    'port' => env('DB_PORT', '3306'),
    'database' => env('DB_DATABASE', 'forge'),
    'username' => env('DB_USERNAME', 'forge'),
    'password' => env('DB_PASSWORD', ''),
    'charset' => 'utf8mb4',
    'collation' => 'utf8mb4_unicode_ci',
    'prefix' => '',
    'strict' => false,
    'engine' => null,
],

2. Antaramuka API Reka Bentuk

Sebelum menulis API, anda perlu menentukan fungsi API dan parameter permintaan dan data tindak balas yang diperlukan. Langkah ini sangat penting dan menentukan penggunaan dan kesan API. Sebagai contoh, katakan kita ingin menulis API untuk mendapatkan senarai produk, maka kita memerlukan maklumat berikut:

• Kaedah permintaan: GET
• URL Permintaan: /api/products
• Parameter permintaan: Tiada parameter diperlukan
• Data respons: Senarai produk

Berikut ialah contoh:

use AppProduct;

Route::get('/api/products', function () {
    return Product::all();
});

Dalam contoh ini, kami menggunakan Laravel Laluan dan model yang disertakan dengan rangka kerja mula-mula menentukan GET alamat URL yang diminta /api/products dalam fail penghalaan, dan kemudian kembalikan semua data produk dalam kaedah pengawal yang sepadan. Di sini kami menggunakan ORM (Pemetaan Hubungan Objek) untuk mengendalikan pangkalan data, yang boleh melaksanakan operasi data dengan cepat dan mudah.

3. Penggunaan middleware

Middleware ialah konsep penting dalam rangka kerja Laravel, yang boleh melakukan beberapa operasi, seperti identiti, sebelum atau selepas permintaan mencapai kaedah pengawal. Pengesahan dsb. Apabila menulis API, anda biasanya perlu menambah beberapa perisian tengah untuk memastikan keselamatan dan prestasi API.

Sebagai contoh, kami boleh menambah perisian tengah untuk mengesahkan maklumat pengepala permintaan, seperti versi API, sama ada Token itu sah, dsb., dan kemudian bertanya dan mengembalikan data dalam kaedah pengawal. Kod sampel adalah seperti berikut:

use AppHttpMiddlewareVerifyApiToken;
use AppHttpMiddlewareVerifyApiVersion;

Route::middleware([VerifyApiToken::class, VerifyApiVersion::class])->group(function () {
    Route::get('/api/products', function () {
        return Product::all();
    });
});

Dalam contoh ini, kami menambah dua middleware middleware dan VerifyApiToken melalui kaedah VerifyApiVersion Mereka akan dilaksanakan sebelum permintaan mencapai kaedah pengawal, memastikan bahawa permintaan Keselamatan dan konsistensi versi.

4. Pengendalian pengecualian

Pengendalian pengecualian juga merupakan pautan penting semasa menulis API Ia membolehkan kami menangkap dan mengendalikan pengecualian dengan lebih baik, seperti ralat parameter input , pertanyaan data tidak wujud, dsb. Dalam rangka kerja Laravel, kita boleh mengendalikan pengecualian secara seragam melalui kelas AppExceptionsHandler.

Sebagai contoh, katakan kita ingin melaksanakan API untuk mendapatkan satu produk dan mengembalikan kod status 404 dan mesej ralat apabila produk itu tidak wujud. Contoh kod adalah seperti berikut:

Route::get('/api/products/{id}', function ($id) {
    $product = Product::find($id);
    if (!$product) {
        abort(404, '商品不存在');
    }
    return $product;
});

Dalam contoh ini, kami menanyakan data produk melalui kaedah find Jika hasil pertanyaan ialah null, kami terus menggunakan kaedah abort untuk mengembalikan 404. kod status dan mesej ralat. Dengan menggunakan pengendalian pengecualian, kami boleh menjadikan API kami lebih teguh dan stabil.

Akhir sekali

Melalui langkah di atas, kami boleh mula menulis API RESTful kami sendiri. Rangka kerja Laravel menyediakan penghalaan lengkap, perisian tengah, ORM dan komponen lain, menjadikan penulisan API sangat mudah dan cekap. Sudah tentu, terdapat banyak lagi panduan penulisan API yang lebih terperinci dan profesional. Saya harap artikel ini dapat memberi rujukan dan inspirasi kepada pembaca.

Atas ialah kandungan terperinci Bagaimana untuk menulis laravel api. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!