ゼロからREST APIを構築する：実装

このチュートリアルの最初の部分は、APIの基礎層、サーバーのセットアップ、認証、JSONの取り扱い、エラー管理、および初期ルートを確立しました。 重要なことに、READMEでリソースとアクションを定義しました。それでは、これらのリソースを実装することにより、この基盤の上に構築しましょう。

重要な概念：

安らかなベストプラクティス：
• 操作を作成および更新して、リソース表現を返します。 堅牢なORM/モデルと検証ライブラリは、生産アプリケーションに不可欠です。 エラー処理と検証：
厳密なエラー処理と検証データの整合性と適切な応答を確保します。 これには、必須フィールド（名のような）と一意の電子メールチェックが含まれます。
• 高度なクエリ：効率的なデータ検索と改善されたクライアント側のパフォーマンスのために、フィルタリング、ソート、およびページネーションを実装してください。
• キャッシング：最適化された応答時間とサーバー負荷の削減のために、ミドルウェアでETAGおよびサーバー側のキャッシュ（APCなど）を利用します。
レートの制限：
• ミドルウェアベースのレート制限は、APIの過剰使用から保護し、可用性と信頼性を確保します。 将来の拡張機能：
高度なORM/モデルソリューション、外部検証ライブラリ、およびAPCを超えた代替ストレージオプションを検討することにより、スケーラビリティの計画。
• 連絡先管理：作成と更新
• 連絡先の作成から始めて、休憩ベストプラクティスは、作成または更新後にリソース表現を返すことを決定します。 この例のデータベースインタラクションは明確にするために簡素化されていますが、制作APIはより堅牢なORM/モデルと検証ライブラリを活用します。
この投稿

エンドポイントは、リクエストボディを処理し、データを検証し、連絡先レコードを作成し、関連するメモ（提供されている場合）を処理し、作成された連絡先のJSON表現を返します。 操作を更新し（

および）、同様のパターンに従って、処理する前に連絡先と存在に注意してください。 および

メソッドは、効率のために同じコードにマッピングされます。

$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);
    }
}
);

リストとフィルタリングの連絡先

/contacts PUT基本的な連絡先リストは簡単です：PATCH PUT ただし、堅牢なAPIは高度なクエリをサポートします。PATCHこの例では、

または

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

を使用して

または内で検索し、でソートする、特定のフィールドの選択を示します。 実装には、入力を消毒し、データベースクエリを動的に構築することが含まれます。

$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);
    }
}
);

このセクションには、fields、sort、page、per_pageパラメーター、クエリの構築、Linkヘッダーの生成を含むページネーションの管理のための詳細なコードが含まれます。

連絡先の詳細と埋め込みリソース

個々の連絡先の詳細を取得するのは簡単です：

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

効率を向上させるために、埋め込まれたリソース（メモなど）は、

などのクエリパラメーターを使用してフェッチできます。 コードは変更され、/api/v1/contacts/1?embed=notesパラメーターが存在する場合、メモの追加クエリが含まれます。 embed

キャッシュとレートの制限キャッシュとレートの制限は、ミドルウェア、パフォーマンスの向上、API保護を使用して実装されます。 ミドルウェアコード（キャッシュとレートの制限の両方）は、元の例に似ています。キャッシュのヒット/ミス、ETAG生成、有効期限、および適切なHTTPヘッダーを含むレート制限チェックの処理。 さらなる開発

この拡張されたAPIは、強固な基盤を提供します。 将来の改善には、より堅牢なORM/モデルへの移行、専用の検証ライブラリの統合、代替ストレージソリューションの探索、API発見の実装（Swaggerなど）、包括的なテストスイートの作成が含まれます。 完全なソースコード（オリジナルで言及されているように）は、完全な実装の詳細を提供します。

以上がゼロからREST APIを構築する：実装の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。