Bangunkan API menggunakan rangka kerja Yii

Menggunakan rangka kerja Yii untuk membangunkan API

Dalam era Internet hari ini, API telah menjadi perniagaan teras banyak syarikat, organisasi dan individu Mereka menggunakan API untuk menyediakan perkhidmatan mereka sendiri dan berinteraksi dengan perkhidmatan lain untuk membentuk A ekosistem yang luas. Rangka kerja Yii ialah rangka kerja berprestasi tinggi, kebolehpercayaan tinggi yang sangat sesuai untuk membina API. Ia menggunakan teknologi PHP terkini dan amalan terbaik serta menyediakan banyak fungsi yang mudah dan pantas untuk membangunkan API.

Dalam artikel ini, kami akan menerangkan cara menggunakan rangka kerja Yii untuk pembangunan API, termasuk cara menyediakan rangka kerja Yii, cara mencipta pengawal API dan cara mengendalikan permintaan API. Mari mulakan!

1. Sediakan rangka kerja Yii

Sebelum memulakan pembangunan rangka kerja Yii, kita perlu memasang rangka kerja Yii terlebih dahulu. Anda boleh memuat turun versi terbaharu rangka kerja Yii daripada tapak web rasmi rangka kerja Yii (https://www.yiiframework.com/), dan kemudian nyahzipnya ke lokasi yang anda inginkan.

Seterusnya, kita perlu mencipta aplikasi Yii. Cipta aplikasi Yii baharu bernama "api" daripada baris arahan menggunakan arahan berikut:

$ php yii init --env=dev api

Perintah di atas akan mencipta aplikasi Yii baharu bernama "api" dalam direktori semasa. Selepas memulakan aplikasi Yii, anda boleh memulakan aplikasi dengan arahan berikut:

$ php yii serve

Secara lalai, aplikasi Yii akan dilancarkan di alamat "http://localhost:8080".

2. Buat Pengawal API

Seterusnya, kita perlu mencipta pengawal API untuk mengendalikan permintaan API. Cipta pengawal baharu bernama "ApiController" daripada baris arahan menggunakan arahan berikut:

$ php yii generate/controller api

Perintah di atas akan mencipta pengawal baharu bernama "ApiController" di bawah direktori "pengawal". Dalam pengawal kami akan menentukan semua kelakuan API. Sebagai contoh, berikut ialah contoh tindakan API mudah:

<?php

namespace appcontrollers;

use Yii;
use yiiestController;
use yiidataActiveDataProvider;
use appmodelsPost;

class ApiController extends Controller
{
    public function actionIndex()
    {
        $dataProvider = new ActiveDataProvider([
            'query' => Post::find(),
            'pagination' => false,
        ]);

        return $dataProvider;
    }
}

Dalam contoh di atas, kami mencipta tindakan API bernama "actionIndex" untuk mengembalikan senarai semua artikel. Dalam pelaksanaan fungsi, kami hanya menggunakan kelas "ActiveDataProvider" yang disediakan oleh rangka kerja Yii untuk mendapatkan semua senarai artikel, dan kemudian menukarnya ke dalam format JSON dan mengembalikannya.

3. Mengendalikan permintaan API

Akhir sekali, kami perlu mengendalikan permintaan API. Cipta fail baharu bernama "api.php" daripada baris arahan menggunakan arahan berikut:

$ touch api.php

Buka fail yang baru anda buat dan tambah kod berikut:

<?php

require __DIR__ . '/vendor/autoload.php';
require __DIR__ . '/vendor/yiisoft/yii2/Yii.php';

$config = require __DIR__ . '/config/web.php';

(new yiiwebApplication($config))->run();

Dalam kod di atas, Kami mula-mula memasukkan fail "vendor/autoload.php" dan "vendor/yiisoft/yii2/Yii.php", yang digunakan untuk autoload rangka kerja Yii dan aplikasi autoload. Kami kemudiannya memuatkan fail konfigurasi aplikasi (config/web.php), mencipta aplikasi Yii baharu dan menjalankannya.

Akhir sekali, kami juga perlu mengkonfigurasi beberapa parameter lain, seperti URL permintaan, kaedah permintaan, parameter permintaan, dsb. Sebagai contoh, berikut ialah contoh permintaan mudah:

http://localhost:8080/index.php?r=api/index

Dalam permintaan di atas, kami menggunakan kaedah permintaan GET untuk mengakses tindakan API bernama "api/index". Jika semuanya berjalan lancar, permintaan ini akan mengembalikan senarai artikel yang diwakili dalam format JSON.

Ringkasan

Di atas ialah langkah asas untuk pembangunan API menggunakan rangka kerja Yii Kami telah mempelajari cara menyediakan rangka kerja Yii, cara mencipta pengawal API dan cara mengendalikan permintaan API . Jika anda ingin menyelami butiran lanjut rangka kerja Yii, sila lawati dokumentasi rasmi rangka kerja Yii (https://www.yiiframework.com/docs).

Dalam proses pembangunan API, perhatian khusus perlu diberikan kepada faktor seperti keselamatan, kebolehbacaan, kebolehgunaan semula dan kebolehskalaan. Hanya dengan melakukan ini kami boleh membangunkan API berkualiti tinggi untuk memenuhi keperluan pengguna. Akhir sekali, saya mengucapkan selamat maju jaya kepada anda dalam menggunakan rangka kerja Yii untuk pembangunan API!

Atas ialah kandungan terperinci Bangunkan API menggunakan rangka kerja Yii. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!