Membina API Pokémon dalam PHP: Panduan Pemula

Dalam panduan ini, kami akan melalui langkah-langkah untuk mencipta projek PHP asas yang menggunakan API Pokémon dengan rangka kerja Penerbangan dan pakej tambahan seperti Zebra_cURL dan Latte. Kami akan meneroka penyediaan projek, menambah laluan dan memaparkan paparan.

tl;dr: Tidak sukar untuk membuat projek berasaskan API mudah dalam Penerbangan. Lihat kod yang digunakan dalam panduan ini.

Langkah 1: Menyediakan Persekitaran

Pertama, kita perlu menyediakan folder projek baharu. Buka terminal anda, navigasi ke lokasi yang anda inginkan dan jalankan arahan berikut untuk mencipta direktori baharu dan masukkannya.

mkdir flight-pokeapi
cd flight-pokeapi

Langkah 2: Memasang Komposer

Sebelum kita menyelami kod, kita perlu memastikan bahawa Komposer dipasang. Komposer ialah pengurus pergantungan untuk PHP dan ia akan membantu kami memasukkan perpustakaan yang diperlukan.

Jika anda tidak memasang Komposer, anda boleh memasangnya menggunakan:

php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php
php -r "unlink('composer-setup.php');"

Sekarang Komposer dipasang dalam fail semasa yang dipanggil ./composer.phar, mari urus kebergantungan kami.

Langkah 3: Memasang Ketergantungan

Untuk mengurus pakej yang diperlukan, kami hanya perlu menambahkannya dengan komposer.

./composer.phar require flightphp/core stefangabos/zebra_curl latte/latte

Ini akan memasang:

• PHP Penerbangan: Rangka kerja PHP yang ringan.
• Zebra_cURL: Pembalut cURL untuk mengendalikan permintaan HTTP.
• Latte: Enjin templat untuk memaparkan paparan.

Langkah 4: Menyediakan index.php

Seterusnya, mari buat titik masuk untuk aplikasi kami: public/index.php. Fail ini akan menyediakan apl kami, mengkonfigurasi laluan dan mengendalikan pemaparan paparan.

Buat direktori awam dan fail index.php:

mkdir public
touch public/index.php

Sekarang tambah kandungan berikut pada index.php:

<?php

use flight\net\Router;
use Latte\Engine;

require __DIR__ . '/../vendor/autoload.php'; // Autoload the installed packages

// Setup Latte for view rendering
$Latte = new Engine;
$Latte->setTempDirectory(__DIR__ . '/../temp');
Flight::map('render', function(string $template_path, array $data = []) use ($Latte) {
  $Latte->render(__DIR__ . '/../views/' . $template_path, $data);
});

// Setup Zebra_cURL for handling HTTP requests
$Curl = new Zebra_cURL();
$Curl->cache(__DIR__ . '/../temp');
Flight::map('curl', function() use ($Curl) { 
    return $Curl; 
});

// Define a simple route
Flight::route('/', function() {
  echo 'hello world!';
});

Flight::start();

Dalam fail ini:

• Kami memuatkan autoloader Komposer.
• Sediakan Latte untuk paparan paparan.
• Peta kaedah pemaparan tersuai yang menggunakan Latte untuk memaparkan templat daripada folder /views.
• Sediakan Zebra_cURL untuk mengendalikan permintaan API dan petakannya untuk menggunakan Flight::curl() apabila kami mahu menggunakannya.
• Tentukan laluan mudah untuk halaman utama (/) yang hanya mengembalikan "hello world!"

Jika anda ingin menguji persediaan ini, anda boleh memulakan pelayan PHP dari direktori awam:

php -S localhost:8000 -t public/

Sekarang, lawati http://localhost:8000/ dalam penyemak imbas anda, dan anda sepatutnya melihat "hello world!". Sejuk eh?

Langkah 5: Menambah Laluan

Sekarang kita telah menyediakan laluan asas, mari tambahkan laluan yang lebih kompleks yang menggunakan API Pokémon. Kemas kini public/index.php untuk memasukkan kod berikut:

Flight::group('/pokemon', function(Router $router) {
    // Route to list all Pokémon types
    $router->get('/', function() {
        $types_response = json_decode(Flight::curl()->scrap('https://pokeapi.co/api/v2/type/', true));
        $results = [];
        while ($types_response->next) {
            $results = array_merge($results, $types_response->results);
            $types_response = json_decode(Flight::curl()->scrap($types_response->next, true));
        }
        $results = array_merge($results, $types_response->results);
        Flight::render('home.latte', [ 'types' => $results ]);
    });
});

• Kami mencipta kumpulan laluan /pokemon. Kumpulan laluan "mengepung" laluan dan membolehkan kami menentukan kefungsian biasa untuk semua laluan dalam kumpulan.
• Laluan /pokemon menyenaraikan semua jenis Pokémon yang tersedia dengan mengambilnya daripada API Pokémon menggunakan Zebra_cURL.
• Ini masih belum berfungsi kerana kita perlu menambah paparan home.latte untuk memaparkan jenis Pokémon.

Langkah 6: Memaparkan Paparan dengan Latte

Sekarang kita sedang mengambil data, mari kita sediakan paparan untuk memaparkannya. Cipta direktori pandangan dan tambahkan fail templat Latte untuk memaparkan jenis Pokémon.

mkdir views
touch views/home.latte

Tambahkan kod berikut pada views/home.latte:

<p>Welcome to the Pokemon World!</p>

<p>Types of Pokemon</p>
<ul>
    {foreach $types as $type}
        <li><a href="/pokemon/type/{$type->name}">{$type->name|firstUpper}</a></li>
    {/foreach}
</ul>

Dalam fail ini:

• Kami mengulangi tatasusunan $types yang diluluskan dari laluan kami dan memaparkan nama setiap jenis Pokémon.

Kini, melawati /pokemon akan memaparkan senarai semua jenis Pokémon!

Langkah 7: Mengumpul dan Menambah Lebih Banyak Laluan

Mari panjangkan laluan Pokémon kami untuk mendapatkan butiran lanjut untuk jenis tertentu dan Pokémon individu. Tambahkan laluan berikut pada kumpulan /pokemon anda:

// Route to fetch a specific Pokémon type and list all associated Pokémon
$router->get('/type/@type', function(string $type) {
    $Curl = Flight::curl();
    $type_response = json_decode($Curl->scrap('https://pokeapi.co/api/v2/type/' . $type, true));
    $pokemon_urls = [];
    foreach($type_response->pokemon as $pokemon_data) {
        $pokemon_urls[] = $pokemon_data->pokemon->url;
    }
    $pokemon_data = [];

    // The little & here is important to pass the variable by reference.
    // In other words it allows us to modify the variable inside the closure.
    $Curl->get($pokemon_urls, function(stdClass $result) use (&$pokemon_data) {
        $pokemon_data[] = json_decode($result->body);
    });

    Flight::render('type.latte', [ 
        'type' => $type_response->name,
        'pokemons' => $pokemon_data
    ]);
});

Dalam laluan ini, kami:

• Ambil butiran untuk jenis Pokémon tertentu, termasuk semua Pokémon yang berkaitan.
• Hantar berbilang permintaan API untuk mengambil butiran bagi setiap Pokémon.
• Render data menggunakan templat (type.latte).

Seterusnya, buat paparan type.latte:

touch views/type.latte

Tambah kandungan berikut untuk menaip.latte:

<h1>{$type|firstUpper}</h1>
<ul>
    {foreach $pokemons as $pokemon}
        <li><a href="/pokemon/{$pokemon->id}">{$pokemon->name|firstUpper}</a></li>
    {/foreach}
</ul>

Templat ini memaparkan nama setiap Pokémon yang dikaitkan dengan jenis tertentu.

Langkah 8: Adakah ia berfungsi?

Pada ketika ini, anda telah menyediakan pengguna API Pokémon asas menggunakan Flight PHP, Zebra_cURL untuk permintaan API dan Latte untuk pemaparan paparan. Anda boleh mengembangkan lagi projek ini dengan menambah lebih banyak laluan dan memperhalusi templat.

Untuk melihat projek anda, mulakan pelayan PHP dari direktori awam:

php -S localhost:8000 -t public/

Sekarang, lawati http://localhost:8000/pokemon dalam penyemak imbas anda, dan anda akan melihat senarai jenis Pokémon.

Menyelesaikan masalah

Jika anda memerlukan bantuan atau menghadapi masalah, anda boleh menyemak kod penuh dalam Github untuk melihat di mana anda mungkin telah tersilap langkah.

Semoga anda menikmati tutorial kecil ini. Jika anda mempunyai sebarang soalan atau memerlukan bantuan, jangan ragu untuk bertanya dalam komen di bawah. Selamat mengekod!

Atas ialah kandungan terperinci Membina API Pokémon dalam PHP: Panduan Pemula. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!