Pembangunan API RESTful dalam rangka kerja Yii

Yii ialah rangka kerja MVC berprestasi tinggi berdasarkan PHP Ia menyediakan set alat dan fungsi yang sangat kaya untuk menyokong pembangunan aplikasi web yang pantas dan cekap. Antaranya, fungsi API RESTful bagi rangka kerja Yii telah menarik perhatian dan kasih sayang lebih ramai pembangun, kerana menggunakan rangka kerja Yii boleh membina antara muka RESTful berprestasi tinggi dan mudah dikembangkan dengan mudah, menyediakan alat yang berkuasa untuk pembangunan daripada aplikasi web.

1. Pengenalan kepada RESTful API

RESTful API ialah gaya reka bentuk API berdasarkan protokol HTTP, yang bertujuan untuk mencipta perkhidmatan web berskala dan mudah diselenggara. Gaya API ini terdiri daripada satu set permintaan dan respons bebas, di mana permintaan itu terdiri daripada kaedah HTTP, URI dan isi mesej, dan respons terdiri daripada kod status HTTP dan badan mesej. REST ialah gaya seni bina tanpa negara, di mana setiap permintaan mengandungi maklumat yang mencukupi untuk difahami sendiri oleh pelayan.

2. API RESTful dalam rangka kerja Yii

Rangka kerja Yii menyediakan sokongan untuk API RESTful, yang membolehkan pembangun membangunkan API Web berkuasa dengan pantas. Secara umumnya terdapat dua cara untuk melaksanakan API RESTful dalam rangka kerja Yii: ActiveController dan UrlRule.

a. ActiveController

ActiveController ialah pelaksanaan berdasarkan kelas pengawal Ia menyediakan satu set operasi CRUD lalai, seperti mendapatkan koleksi sumber, mendapatkan satu sumber, mencipta sumber. dan mengemas kini sumber dan memadamkan sumber. Pembangun hanya perlu mewarisi kelas ActiveController dan melebihkan kaedah yang sepadan untuk melaksanakan antara muka API mereka sendiri. Berikut ialah contoh mudah:

class PostController extends ActiveController
{
    public $modelClass = 'appmodelsPost';
}

Di sini kita mewarisi kelas ActiveController dan menetapkan atribut $modelClass kepada 'appmodelsPost'. Ini secara automatik akan mencipta antara muka CRUD yang sepadan berdasarkan definisi model Post. Contohnya, meminta GET /posts akan mengembalikan semua data siaran, dan meminta POST /posts akan membuat siaran baharu.

b. UrlRule

UrlRule ialah peraturan penghalaan dalam rangka kerja Yii, yang melaluinya permintaan HTTP boleh dipetakan kepada Pengawal dan Tindakan yang sepadan. Cara untuk melaksanakan API RESTful menggunakan UrlRule adalah agak fleksibel Kita boleh menentukan peraturan penghalaan yang berbeza mengikut keperluan kita sendiri. Contohnya, kita boleh menggunakan kod berikut untuk mentakrifkan antara muka /posts:

'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        ['class' => 'yiiestUrlRule', 'controller' => 'post'],
    ],
],

Melalui konfigurasi ini. , kami boleh mengakses / menghantar antara muka untuk mendapatkan data semua artikel.

3. Keselamatan API RESTful

Keselamatan ialah isu yang sangat penting apabila membangunkan API RESTful. Rangka kerja Yii menyediakan pelbagai mekanisme keselamatan untuk melindungi keselamatan antara muka API, yang paling biasa digunakan ialah Kawalan Akses dan Token Pembawa.

a. Kawalan Akses

Kawalan Akses mengurus akses pengguna kepada API melalui peraturan kebenaran. Rangka kerja Yii menyediakan satu set kelas kawalan kebenaran berkuasa yang boleh melaksanakan mod pengurusan kebenaran RBAC (Kawalan Akses Berasaskan Peranan) dengan mudah. Sebagai contoh, kita boleh menggunakan kod berikut untuk menentukan kawalan akses dalam pengawal:

public function behaviors()
{
    $behaviors = parent::behaviors();
    $behaviors['access'] = [
        'class' => AccessControl::className(),
        'rules' => [
            [
                'actions' => ['create', 'update'],
                'allow' => true,
                'roles' => ['@'],
            ],
            [
                'actions' => ['view', 'index'],
                'allow' => true,
                'roles' => ['?', '@'],
            ],
        ],
    ];
    return $behaviors;
}

Di sini kami mentakrifkan dua peraturan, sepadan dengan operasi dan kebenaran pengguna yang berbeza. Sebagai contoh, kaedah cipta dan kemas kini memerlukan pengguna log masuk sebelum mereka boleh diakses, manakala kaedah paparan dan indeks boleh diakses oleh pengguna tanpa nama dan pengguna log masuk.

b. Token Pembawa

Token Pembawa ialah kaedah pengesahan identiti berdasarkan OAuth2, yang boleh membawa access_token sebagai bukti kelayakan identiti dalam permintaan API. Rangka kerja Yii menyediakan dua kaedah, BasiAuth dan OAuth2, yang boleh melaksanakan pengesahan identiti Token Pembawa dengan mudah. Sebagai contoh, kami boleh mendayakan pengesahan OAuth2 dalam aplikasi menggunakan kod berikut:

'authManager' => [
    'class' => 'yiiiltersuthQueryParamAuth',
    'tokenParam' => 'accessToken',
],

Kemudian kami boleh membawa access_token sebagai bukti kelayakan dalam URL semasa membuat panggilan API, seperti:

GET /posts?accessToken=ABCDEF123456

4. Ringkasan

Rangka kerja Yii ialah rangka kerja MVC yang sangat berkuasa yang boleh membangunkan API RESTful berprestasi tinggi dan mudah berskala dengan mudah. Dalam pembangunan RESTful API, keselamatan merupakan isu yang sangat penting Rangka kerja Yii menyediakan pelbagai mekanisme keselamatan untuk melindungi keselamatan antara muka API. Contohnya, Kawalan Akses dan Token Pembawa boleh digunakan untuk kebenaran dan pengesahan identiti masing-masing, mengoptimumkan keselamatan RESTful API. Oleh itu, apabila menggunakan rangka kerja Yii untuk membangunkan API RESTful, anda mesti memberi perhatian kepada keselamatan dan mewujudkan mekanisme keselamatan API yang boleh dipercayai.

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