Bagaimana untuk mencipta API dengan PHP Tulen?

Dalam projek ini kami akan mencipta API Mudah menggunakan PHP sahaja dalam mana-mana rangka kerja. Apa yang kita perlukan ialah:

• PHP - Penting
• Komposer - Penting
• Editor/IDE seperti VScode atau PHPStorm
• Docker - Diutamakan tetapi tidak penting
• Posmen - Diutamakan, tetapi tidak penting

Mari mulakan dengan mentakrifkan fail docker-compose.yml kami untuk konfigurasi pangkalan data kami. Jika anda tidak mahu menggunakan Docker untuk mencipta pangkalan data dalam bekas, penyelesaiannya ialah memasang pangkalan data pada mesin anda. Untuk tutorial ini kami akan menggunakan MySQL.

tetapan

Selepas mencipta folder di mana aplikasi kami akan ditempatkan, kami mulakan dengan mengkonfigurasi docker-compose.yaml:

services:
  mysql:
    image: mysql:9.1.0
    ports:
      - '3306:3306'
    environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Mari pecahkan fail ini kepada beberapa bahagian untuk penjelasan:

services:
  mysql:

Dalam fail ini kami mentakrifkan perkhidmatan yang akan digunakan.
Saya menamakan perkhidmatan ini mysql. Perhatian, nama perkhidmatan ini akan digunakan untuk menyambung ke pangkalan data sebagai hos

image: mysql:9.1.0

Seterusnya saya menentukan imej mana yang akan digunakan untuk mencipta pangkalan data kami, untuk projek ini saya menggunakan versi 9.1.0 mysql.
Anda boleh menemui ini dan versi lain di Docker Hub.

ports:
      - '3306:3306'

Port sedang ditetapkan kepada 3306. Ini ialah port mysql lalai!

Anda boleh perhatikan bahawa port adalah seperti 3306:3306, ini : bermakna kami mahu mendengar port ini pada mesin tempatan kami dan bukan hanya pada bekas docker, jadi kami boleh mengaksesnya terus pada mesin kami.

environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Sebagai persekitaran, kami mesti menentukan kelayakan untuk perkhidmatan mysql kami.
Oleh itu, kami mentakrifkan nama pengguna, kata laluan dan pangkalan data menggunakan pembolehubah persekitaran:

MYSQL_USER: api_user // <--- Este é nosso usuário

MYSQL_PASSWORD: api_password // <--- Este é nosso password

MYSQL_DATABASE: api_example // <--- Este é nosso banco de dados

MYSQL_ROOT_PASSWORD: useroot // <--- Está é a senha para o usuário root

Untuk memulakan bekas kami, hanya berada di dalam folder di mana fail docker-compose.yaml terletak dan taip arahan berikut dalam terminal kami:

docker compose up -d

Ini akan memulakan perkhidmatan mysql dalam bekas kami.
Jika anda ingin mengakses mysql dalam terminal, anda boleh menggunakan arahan ini:

docker exec -it <nome do container> bash

Selepas menaip arahan ini dan menekan enter anda akan memasuki bekas di mana imej mysql sedang berjalan.

Nama bekas dibentuk oleh nama folder-nama hos-nombor
Dalam kes ini, nama bekas kami ialah: create-api-php-mysql-1 jika aplikasi kami dibuat dalam direktori "create-api-php".

Kami juga akan mencipta fail composer.json, fail ini akan menjadi asas untuk memasang perpustakaan luaran yang akan digunakan dalam projek. Dalam projek ini kami hanya akan menggunakan Dotenv.

services:
  mysql:
    image: mysql:9.1.0
    ports:
      - '3306:3306'
    environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Dalam baris ini kami menambah perpustakaan yang paling banyak digunakan untuk dotenv dalam php.
Anda boleh mencari repositori untuk lib ini di: Github Vlucas Repository

services:
  mysql:

Dalam baris di bawah kami pada asasnya mengatakan bahawa kami akan menggunakan autoload dengan konfigurasi lalai PSR-4. PSR yang paling banyak digunakan pada masa ini ialah PSR-12 dan PSR-4, dengan 12 adalah yang paling banyak digunakan setakat ini. Tetapi buat masa ini kami akan terus menggunakan PSR-4.

image: mysql:9.1.0

Dengan dua fail yang dicipta ini, kami boleh memberikan arahan

ports:
      - '3306:3306'

Ia akan memasang pustaka Dotenv dan mengkonfigurasi tetapan untuk PSR yang diingini.
Selepas arahan ini, fail composer.lock.

Bagi mereka yang datang dari dunia JavaScript, fail ini boleh dibandingkan dengan package.json dan package-lock.json.

Anda juga akan melihat bahawa folder telah ditambahkan pada direktori anda dengan vendor nama Ia mengandungi lib Dotenv kami dan juga fail yang sangat penting: autoload.php.
Kami tidak perlu menyentuh atau menukar apa-apa dalam fail ini, kerana ia akan bertanggungjawab untuk melakukan transaksi maklumat Dotenv antara fail kami yang lain.

Kami juga akan mencipta fail yang dipanggil bootstrap.php, fail ini bertanggungjawab untuk memulakan aplikasi kami dan menyambung beberapa parameter penting supaya semuanya berfungsi seperti yang diharapkan:

environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Kami kemudiannya boleh mencipta fail .env untuk menambah pembolehubah persekitaran yang akan bertanggungjawab untuk menyambung ke pangkalan data mysql kami.
Kami kemudian menambah:

MYSQL_USER: api_user // <--- Este é nosso usuário

Kami juga akan membuat fail .env.example di mana salinan maklumat ini akan disimpan sekiranya seseorang ingin mengklon repositori kami atau bahkan untuk kami pada masa hadapan jika kami ingin meneruskan projek kami, dengan cara ini kami akan mempunyai maklumat yang diperlukan untuk mengetahui apa yang kita perlukan tentukan dan apa yang kita tidak perlukan.

MYSQL_PASSWORD: api_password // <--- Este é nosso password

Sebab kami akan mencipta dua fail ini, satu mengandungi semua maklumat dan satu lagi mengandungi hanya sebahagian daripada maklumat, adalah kerana fail .env tidak sepatutnya dimuat naik ke repositori, kerana ia mengandungi maklumat sulit. Katakan pada masa hadapan kami ingin menggunakan API pihak ketiga yang mana kami perlu menambah token untuk akses, kemudian kami akan menyimpan maklumat ini dalam fail .env.

Untuk mengelakkan fail .env daripada dimuat naik ke repositori kami, kami akan mencipta fail bernama .gitignore dan menambah maklumat berikut:

MYSQL_DATABASE: api_example // <--- Este é nosso banco de dados

Dengan cara ini kami mentakrifkan bahawa fail .env dan keseluruhan kandungan folder vendor tidak akan dilakukan.

Dengan ini kami telah selesai mengkonfigurasi projek kami dan bebas untuk meneruskan pengekodan.

Kodifikasi

Kami akan mencipta direktori berikut src/System dan dalam Sistem fail DatabaseConnector.php

services:
  mysql:
    image: mysql:9.1.0
    ports:
      - '3306:3306'
    environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Di sini kami mentakrifkan ruang nama untuk fail ini, supaya kami boleh menggunakannya pada masa hadapan dalam fail lain.

services:
  mysql:

Kami akan mencipta kelas kami dengan nama yang sama dengan fail dan mencipta pembolehubah peribadi bernama $dbConnection yang melepasi nilai null.
Pembolehubah ini akan bertanggungjawab untuk kejadian baharu kelas ini dan menghubungkan kami dengan pangkalan data.
Kita akan lihat lebih banyak kemudian apabila kita melaksanakan cuba-tangkap.

image: mysql:9.1.0

Dalam pembina kami akan mencipta pembolehubah berikut dan menyemak nilai yang ditangkap daripada fail .env dengan Dotenv.

ports:
      - '3306:3306'

Masih di dalam pembina, kami akan melakukan tangkapan cuba untuk mengesahkan tindakan yang ingin kami lakukan:

environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Dalam percubaan ini, kami cuba mencipta contoh baharu kelas kami dan menghantarnya ke pembolehubah $dbConnection. Kami menggunakan modul PDO untuk ini di mana ia menerima parameter

• DSN - Nama Sumber Data atau URI
• - mysql: Menjadi perkhidmatan/bank yang kami gunakan.
• - hos=$host; Hos Kami
• - port=$port; Pintu kami
• - charset=utf8mb4; Takrif set aksara utf8 untuk pangkalan data
• - dbname=$db Nama pangkalan data kami
• PENGGUNA - Pengguna untuk log masuk ke pangkalan data
• LULUS - Kata laluan untuk log masuk ke pangkalan data

Kes ralat:

MYSQL_USER: api_user // <--- Este é nosso usuário

Kami akan mencetuskan pengecualian daripada PDO dan mengembalikan mesej ralat.
Jelas sekali ini hanyalah contoh bagaimana kita harus membentangkan ralat dalam persekitaran pembangunan. Untuk persekitaran pengeluaran, adalah amalan yang baik untuk mengemukakan ralat yang lebih ringkas yang membantu kami memahami masalah dengan lebih jelas.

Di luar pembina tetapi di dalam kelas kami, kami akan mencipta fungsi berikut:

MYSQL_PASSWORD: api_password // <--- Este é nosso password

Bertanggungjawab untuk memanggil pembolehubah kami yang mengandungi tika sambungan kami.

Ingat fail bootstrap.php kami? Mari tambahkan baris kod berikut padanya:

MYSQL_DATABASE: api_example // <--- Este é nosso banco de dados

Kelihatan seperti ini:

MYSQL_ROOT_PASSWORD: useroot // <--- Está é a senha para o usuário root

Di dalam folder src kami akan mencipta direktori lain dengan nama Pangkalan Data dan di dalamnya fail database_seed.php.
Fail ini akan bertanggungjawab untuk mengisi pangkalan data kami buat kali pertama, jadi jika kami ingin berkongsi projek ini dengan seseorang, ia tidak akan berakhir dengan pangkalan data kosong.

Di dalam fail ini kami akan menambah kod berikut:

services:
  mysql:
    image: mysql:9.1.0
    ports:
      - '3306:3306'
    environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Kami mengimport memerlukan 'bootstrap.php'; kerana dalam fail bootstrap kami, kami telah mengimport pembolehubah yang bertanggungjawab untuk menginstant pangkalan data kami.

services:
  mysql:

Kami mencipta pembolehubah dengan nama $statement yang mempunyai nilai Heredoc

image: mysql:9.1.0

Dalam Heredoc ini kami akan menambah beberapa pertanyaan:

ports:
      - '3306:3306'

Di sini saya memilih jatuhkan jadual untuk menjatuhkan keseluruhan pangkalan dan kemudian memulakan yang baharu, namun jika anda mahu anda boleh mengalih keluar baris kod ini.

Barisan kod berikut menyatakan bahawa jadual ini akan digunakan untuk menjalankan transaksi dan akan mempunyai sambungan antara jadual. Jika anda ingin mengetahui lebih lanjut tentang perisytiharan mysql ini: dokumentasi innoDb

environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Dalam hal yang sama Heredoc kami akan menambah satu lagi pertanyaan:

MYSQL_USER: api_user // <--- Este é nosso usuário

Di sini kami memasukkan beberapa data ke dalam jadual orang.

Kami membuat tangkapan cuba di penghujung fail yang mana kami cuba memulakan pertanyaan dan sekiranya berlaku ralat kami mengembalikan mesej ralat seperti yang kami lakukan dalam pemprosesan data dalam kod di atas .

MYSQL_PASSWORD: api_password // <--- Este é nosso password

Di dalam src kami akan mencipta direktori lain dengan nama TableGateways dan di dalamnya kami akan mencipta fail: PersonGateway.php.

MYSQL_DATABASE: api_example // <--- Este é nosso banco de dados

Fail di dalam folder ini akan bertanggungjawab untuk berinteraksi dengan pangkalan data kami, hampir seperti Repositori.

Dalam kelas PersonGateway kami, kami akan menambah pembina berikut:

MYSQL_ROOT_PASSWORD: useroot // <--- Está é a senha para o usuário root

Kami akan menambah pembina ini kerana kelas kami akan dipanggil dalam fail lain supaya kami boleh mencetuskan beberapa kaedah kelas kami.

Lihat kaedah berikut:

Kaedah yang bertanggungjawab untuk menyenaraikan semua pengguna dalam jadual kami

docker compose up -d

Kaedah yang bertanggungjawab untuk menyenaraikan satu pengguna daripada jadual kami

docker exec -it <nome do container> bash

Kaedah yang bertanggungjawab untuk memasukkan pengguna ke dalam jadual kami

{
  "require": {
      "vlucas/phpdotenv": "^2.4"
  },
  "autoload": {
      "psr-4": {
          "Src\": "src/"
      }
  }
}

Kaedah yang bertanggungjawab untuk mengemas kini maklumat pengguna dalam jadual kami

"require": {
      "vlucas/phpdotenv": "^2.4"
},

Kaedah yang bertanggungjawab untuk memadam pengguna daripada jadual kami

"autoload": {
      "psr-4": {
          "Src\": "src/"
      }
  }

Kami akan mencipta dalam src direktori dengan nama Pengawal dan di dalamnya fail: PersonController.php.
Fail dalam direktori ini bertanggungjawab untuk berinteraksi dengan laluan aplikasi kami. Di sini kami berinteraksi secara langsung dengan bank, tetapi kami boleh menggunakan lapisan perkhidmatan dan mengehadkan semua logik dan peraturan perniagaan pada lapisan ini.
Jika anda ingin mencipta lapisan perkhidmatan, ia akan menjadi seperti ini:

services:
  mysql:
    image: mysql:9.1.0
    ports:
      - '3306:3306'
    environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Namun, niat kami bukanlah untuk mendalami seni bina jenis ini, buat masa ini kami akan meneruskan dengan fail pengawal:

services:
  mysql:

Di dalam kelas PersonController kami, kami akan menambah:

image: mysql:9.1.0

Dengan cara ini kami menjamin bahawa kami berinteraksi dengan tika baharu pangkalan data kami.

Kami juga mencipta kaedah untuk memproses permintaan kami:

ports:
      - '3306:3306'

header ini bertanggungjawab untuk menghantar kod status dan jika badan dicipta ia mengembalikan badan yang sama ini untuk dilihat.

environment:
      MYSQL_ROOT_PASSWORD: useroot
      MYSQL_USER: api_user
      MYSQL_PASSWORD: api_password
      MYSQL_DATABASE: api_example

Kami juga mencipta kaedah yang akan berinteraksi dengan laluan:

Kaedah yang bertanggungjawab untuk berinteraksi dengan laluan penyenaraian pengguna

MYSQL_USER: api_user // <--- Este é nosso usuário

Kaedah yang bertanggungjawab untuk berinteraksi dengan laluan penciptaan pengguna

MYSQL_PASSWORD: api_password // <--- Este é nosso password

Kaedah yang bertanggungjawab untuk berinteraksi dengan laluan kemas kini pengguna

MYSQL_DATABASE: api_example // <--- Este é nosso banco de dados

Kaedah yang bertanggungjawab untuk berinteraksi dengan laluan pemadaman pengguna

MYSQL_ROOT_PASSWORD: useroot // <--- Está é a senha para o usuário root

Kaedah yang bertanggungjawab untuk pengesahan

docker compose up -d

docker exec -it <nome do container> bash

{
  "require": {
      "vlucas/phpdotenv": "^2.4"
  },
  "autoload": {
      "psr-4": {
          "Src\": "src/"
      }
  }
}

Akhir sekali, kami akan membuat direktori di luar folder kami src dengan nama Awam.
Folder ini bertanggungjawab untuk mengandungi fail paparan php.
Kami akan mencipta fail di dalamnya: index.php
Kami akan menambah kod berikut:

"require": {
      "vlucas/phpdotenv": "^2.4"
},

Fail ini bertanggungjawab untuk menetapkan pengepala dan menyemak akses kepada url. Jika akses berjaya ia mengembalikan kandungan, jika tidak ia mengembalikan ralat.

Untuk mengakses aplikasi anda, cuma muat naik pelayan menggunakan pelayan PHP dalaman:

"autoload": {
      "psr-4": {
          "Src\": "src/"
      }
  }

jika anda belum memulakan bekas, taip arahan berikut dalam terminal:

composer install

Sekarang hanya gunakan posmen atau mana-mana aplikasi lain yang membantu anda berinteraksi dengan url.

Rangkaian sosial saya:
Github Linkedin

Atas ialah kandungan terperinci Bagaimana untuk mencipta API dengan PHP Tulen?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!