PHP を使用して RESTful API を構築するにはどうすればよいですか?-PHPチュートリアル-php.cn

PHP を使用して RESTful API を構築するにはどうすればよいですか?

WBOY

リリース： 2024-04-19 14:39:02

オリジナル

1142 人が閲覧しました

PHP を使用して RESTful API を構築するにはどうすればよいですか?プロジェクトを作成し、クライアントのリクエストを処理するためのルーティングを構成します。ルート内のメソッドを処理するコントローラーを作成します。オブジェクトの関係をマッピングすることにより、エンティティをデータベーステーブルにマッピングします。 API を実行し、認証、データ検証、エラー処理を処理します。

如何使用 PHP 构建 RESTful API？

PHP を使用して RESTful API を構築する方法

はじめに

RESTful API は、REST (Representational State Transfer) 原則に従うネットワークアプリケーションインターフェイスです。 REST API を使用すると、クライアントはサーバーと対話してデータを取得、作成、更新、または削除できます。 PHP を使用して RESTful API を構築するのは非常に簡単です。この記事では、そのプロセスを段階的に説明します。

前提条件

PHP 7.4 以降
Composer
データベース (オプション)

プロジェクトの作成

まず、Composer を使用して新しいプロジェクトを作成します。

composer create-project symfony/skeleton my-api

ログイン後にコピー

ルーティングの構成

# でルートを定義します。クライアントからのリクエストを処理する ##config/routes.yaml:

# config/routes.yaml
users:
    path: /users
    methods: [GET, POST]
    controller: App\Controller\UserController

ログイン後にコピー

コントローラーの作成

ルーティング処理のメソッドへのコントローラーを作成:

# src/Controller/UserController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class UserController extends AbstractController
{
    /**
     * @Route("/users", methods={"GET"})
     */
    public function index(): Response
    {
        // 获取用户数据
        $users = $this->getDoctrine()
            ->getRepository(User::class)
            ->findAll();

        // 返回 JSON 响应
        return $this->json($users);
    }
}

ログイン後にコピー

実際のケース: ユーザー API の構築

次に、単純なユーザー API を構築する実際のケースを示します:

# src/Entity/User.php
namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 */
class User
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255)
     */
    private $name;

    // getters and setters omitted for brevity
}

ログイン後にコピー

オブジェクトの関係のマッピング

Doctrine ORM を使用してユーザーエンティティをデータベーステーブルにマップします:

# config/packages/doctrine.yaml
doctrine:
    dbal:
        driver: pdo_mysql
        url: '%env(DATABASE_URL)%'
    orm:
        auto_generate_proxy_classes: true
        naming_strategy: doctrine.orm.naming_strategy.underscore

ログイン後にコピー

API を実行します

次のコマンドを使用します API を実行します: