Construisez une API REST à partir de zéro: implémentation

La première partie de ce didacticiel a établi les couches fondamentales de notre API: configuration du serveur, authentification, manipulation JSON, gestion des erreurs et itinéraires initiaux. Surtout, nous avons défini les ressources et les actions dans le Readme. Maintenant, appuyons sur cette fondation en mettant en œuvre ces ressources.

Concepts clés:

• RESTFUL BESTS PRATIQUES: Créer et mettre à jour les opérations renvoient les représentations des ressources. Les bibliothèques robustes de l'ORM / du modèle et de validation sont essentielles pour les applications de production.
• Gestion et validation des erreurs: La gestion et la validation des erreurs rigoureuses assurent l'intégrité des données et les réponses appropriées. Cela inclut les champs obligatoires (comme le prénom) et les vérifications de courrier électronique uniques.
• Interrogation avancée: Implémentez le filtrage, le tri et la pagination pour une récupération efficace des données et une amélioration des performances côté client.
• Cache: Utilisez la mise en cache ETAG et côté serveur (par exemple, APC) avec des middleware pour des temps de réponse optimisés et une charge de serveur réduite.
• Limitation du taux: La limitation des taux basée sur les middleware protège contre la surutilisation de l'API, assurant la disponibilité et la fiabilité.
• Améliorations futures: Planifier l'évolutivité en considérant les solutions ORM / modèles avancées, les bibliothèques de validation externe et les options de stockage alternatives au-delà de l'APC.

Gestion des contacts: création et mises à jour

En commençant par la création de contacts, les meilleures pratiques de repos dictent le renvoi d'une représentation des ressources après la création ou la mise à jour. Bien que l'interaction de la base de données dans cet exemple soit simplifiée pour plus de clarté, une API de production exploiterait une bibliothèque ORM / modèle et de validation plus robuste.

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

Ce message /contacts Termine le point de vue du corps de la demande, valide les données, crée un enregistrement de contact, gère les notes associées (si fournies) et renvoie une représentation JSON du contact créé. Les opérations de mise à jour (PUT et PATCH) suivent un modèle similaire, en vérifiant le contact et notez l'existence avant le traitement. Les méthodes PUT et PATCH sont mappées au même code pour l'efficacité:

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

Listing de contact et filtrage

La liste de contacts de base est simple:

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

Cependant, une API robuste prend en charge la requête avancée: /api/v1/contacts?fields=firstname,email&sort=-email&firstname=Viola&q=vitae Cet exemple démontre le filtrage par firstname, la recherche dans firstname ou email en utilisant q, le tri par email et la sélection de champs spécifiques. L'implémentation implique la désinfection des entrées et la construction dynamiquement de la requête de base de données:

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

Cette section comprendrait le code détaillé pour la manipulation fields, sort, page, per_page paramètres, la construction de la requête et la gestion de la pagination, y compris la génération de Link en-têtes.

coordonnées et ressources intégrées

La récupération des coordonnées individuelles est simple:

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

Pour améliorer l'efficacité, les ressources intégrées (par exemple, les notes) peuvent être récupérées à l'aide de paramètres de requête comme /api/v1/contacts/1?embed=notes. Le code serait modifié pour inclure une requête supplémentaire pour les notes si le paramètre embed est présent.

Cache et limite de taux

La mise en cache et la limitation des taux sont implémentées à l'aide de middleware, améliorant les performances et la protection de l'API. Le code du middleware (pour la mise en cache et la limitation des taux) serait similaire à l'exemple d'origine, gérer les coups / ratés de cache, la génération ETAG, l'expiration et les contrôles de limite de taux, y compris les en-têtes HTTP appropriés.

développement ultérieur

Cette API améliorée fournit une base solide. Les améliorations futures incluent la migration vers un ORM / modèle plus robuste, l'intégration d'une bibliothèque de validation dédiée, l'exploration de solutions de stockage alternatives, la mise en œuvre de la découverte d'API (par exemple, Swagger) et la création d'une suite de test complète. Le code source complet (comme mentionné dans l'original) fournirait les détails complets de l'implémentation.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!