Bina API rehat dari awal: pelaksanaan

Bahagian pertama tutorial ini menubuhkan lapisan asas API kami: persediaan pelayan, pengesahan, pengendalian JSON, pengurusan ralat, dan laluan awal. Secara kritis, kami menentukan sumber dan tindakan dalam Readme. Sekarang, mari kita bina asas ini dengan melaksanakan sumber -sumber tersebut.

Konsep Utama:

• Amalan Terbaik Resfful: Buat dan mengemas kini Operasi Return Respress Representations. Perpustakaan ORM/Model dan pengesahan yang kuat adalah penting untuk aplikasi pengeluaran.
• Pengendalian & Pengesahan Ralat: Pengendalian dan pengesahan ralat yang ketat Pastikan integriti data dan respons yang sesuai. Ini termasuk medan wajib (seperti nama pertama) dan cek e -mel yang unik.
• pertanyaan lanjutan: Melaksanakan penapisan, penyortiran, dan penomboran untuk pengambilan data yang efisien dan peningkatan prestasi klien.
• Caching: Gunakan ETAG dan caching sisi pelayan (mis., APC) dengan middleware untuk masa tindak balas yang dioptimumkan dan beban pelayan yang dikurangkan.
• Mengehadkan kadar: Kadar berasaskan middleware yang mengehadkan melindungi terhadap penggunaan berlebihan API, memastikan ketersediaan dan kebolehpercayaan.
• Peningkatan Masa Depan: Rancang untuk skalabilitas dengan mempertimbangkan penyelesaian ORM/Model maju, perpustakaan pengesahan luaran, dan pilihan storan alternatif di luar APC.

Pengurusan Kenalan: Penciptaan dan Kemas Kini

Bermula dengan Penciptaan Hubungan, Amalan Terbaik Rest menentukan kembali perwakilan sumber selepas penciptaan atau kemas kini. Walaupun interaksi pangkalan data dalam contoh ini dipermudahkan untuk kejelasan, API pengeluaran akan memanfaatkan ORM/Model dan Perpustakaan Pengesahan yang lebih mantap.

$app->post(
'/contacts',
function () use ($app, $log) {
    $body = $app->request()->getBody();
    $errors = $app->validateContact($body);

    if (empty($errors)) {
        $contact = \ORM::for_table('contacts')->create();

        if (isset($body['notes'])) {
            $notes = $body['notes'];
            unset($body['notes']);
        }

        $contact->set($body);

        if ($contact->save()) {
            if (!empty($notes)) {
                $contactNotes = [];
                foreach ($notes as $item) {
                    $item['contact_id'] = $contact->id;
                    $note = \ORM::for_table('notes')->create();
                    $note->set($item);
                    if ($note->save()) {
                        $contactNotes[] = $note->asArray();
                    }
                }
            }

            $output = $contact->asArray();
            if (!empty($contactNotes)) {
                $output['notes'] = $contactNotes;
            }
            echo json_encode($output, JSON_PRETTY_PRINT);
        } else {
            throw new Exception("Unable to save contact");
        }
    } else {
        throw new ValidationException("Invalid data", 0, $errors);
    }
}
);

Posting ini

endpoint memproses badan permintaan, mengesahkan data, mencipta rekod kenalan, mengendalikan nota yang berkaitan (jika disediakan), dan mengembalikan perwakilan JSON dari kenalan yang dicipta. Kemas kini Operasi ( dan /contacts) Ikuti corak yang sama, menyemak kewujudan dan nota kewujudan sebelum diproses. Kaedah PUT dan dipetakan ke kod yang sama untuk kecekapan: PATCH PUT PATCH

Penyenaraian dan Penapisan Hubungi

$app->map(
'/contacts/:id',
function ($id) use ($app, $log) {
    // Update code here...
})->via('PUT', 'PATCH');

Penyenaraian hubungan asas adalah mudah:

Walau bagaimanapun, API yang mantap menyokong pertanyaan lanjutan:

Contoh ini menunjukkan penapisan oleh

$app->get(
'/contacts',
function () use ($app, $log) {
    $contacts = \ORM::forTable('contacts')->findArray();
    echo json_encode($contacts, JSON_PRETTY_PRINT);
}
);

, mencari dalam

atau /api/v1/contacts?fields=firstname,email&sort=-email&firstname=Viola&q=vitae menggunakan firstname, menyusun oleh firstname, dan memilih medan tertentu. Pelaksanaan ini melibatkan sanitizing input dan secara dinamik membina pertanyaan pangkalan data: email

$app->post(
'/contacts',
function () use ($app, $log) {
    $body = $app->request()->getBody();
    $errors = $app->validateContact($body);

    if (empty($errors)) {
        $contact = \ORM::for_table('contacts')->create();

        if (isset($body['notes'])) {
            $notes = $body['notes'];
            unset($body['notes']);
        }

        $contact->set($body);

        if ($contact->save()) {
            if (!empty($notes)) {
                $contactNotes = [];
                foreach ($notes as $item) {
                    $item['contact_id'] = $contact->id;
                    $note = \ORM::for_table('notes')->create();
                    $note->set($item);
                    if ($note->save()) {
                        $contactNotes[] = $note->asArray();
                    }
                }
            }

            $output = $contact->asArray();
            if (!empty($contactNotes)) {
                $output['notes'] = $contactNotes;
            }
            echo json_encode($output, JSON_PRETTY_PRINT);
        } else {
            throw new Exception("Unable to save contact");
        }
    } else {
        throw new ValidationException("Invalid data", 0, $errors);
    }
}
);

Bahagian ini termasuk kod terperinci untuk pengendalian fields, sort, page, per_page parameter, membina pertanyaan, dan menguruskan penomboran termasuk penjanaan Link header.

Butiran Perhubungan dan Sumber Terbenam

Mendapatkan butiran hubungan individu adalah mudah:

$app->map(
'/contacts/:id',
function ($id) use ($app, $log) {
    // Update code here...
})->via('PUT', 'PATCH');

Untuk meningkatkan kecekapan, sumber tertanam (mis., Nota) boleh diambil menggunakan parameter pertanyaan seperti /api/v1/contacts/1?embed=notes. Kod akan diubah suai untuk memasukkan pertanyaan tambahan untuk nota jika parameter embed hadir.

caching dan mengehadkan kadar

caching dan pengehadangan kadar dilaksanakan menggunakan middleware, meningkatkan prestasi dan perlindungan API. Kod middleware (untuk kedua -dua caching dan mengehadkan kadar) akan sama dengan contoh asal, pengendalian hits/terlepas cache, penjanaan etag, tamat tempoh, dan pemeriksaan had kadar, termasuk tajuk HTTP yang sesuai.

Pembangunan selanjutnya

API yang dipertingkatkan ini menyediakan asas yang kukuh. Penambahbaikan masa depan termasuk berpindah ke ORM/model yang lebih mantap, mengintegrasikan perpustakaan pengesahan khusus, meneroka penyelesaian storan alternatif, melaksanakan penemuan API (mis., Swagger), dan mewujudkan suite ujian yang komprehensif. Kod sumber lengkap (seperti yang dinyatakan dalam asal) akan memberikan butiran pelaksanaan penuh.

Atas ialah kandungan terperinci Bina API rehat dari awal: pelaksanaan. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!