从头开始构建REST API：实现

>本教程的第一部分建立了我们API的基础层：服务器设置，身份验证，JSON处理，错误管理和初始路由。 至关重要的是，我们定义了读书文件中的资源和行动。现在，让我们通过实施这些资源来建立这个基础。

>

密钥概念：

• >及时的最佳实践：创建和更新操作返回资源表示。 强大的ORM/模型和验证库对于生产应用程序至关重要。
>
• 错误处理和验证：严格的错误处理和验证确保数据完整性和适当的响应。 这包括强制性字段（例如名字）和唯一的电子邮件检查。
• 高级查询：>实现过滤，分类和分页，以进行有效的数据检索和改进的客户端性能。>
• >缓存：>使用中间件的ETAG和服务器端缓存（例如APC），以进行优化的响应时间和减少的服务器加载。
速率限制：
• 基于中间件的限制限制API过度使用，确保可用性和可靠性。 通过考虑高级ORM/模型解决方案，外部验证库以及APC以外的替代存储选项， 未来的增强：
可扩展性的计划。
• > 联系人管理：创建和更新

>

>从联系创建开始，REST最佳实践决定创建或更新后返回资源表示。 虽然为清晰度简化了此示例中的数据库交互，但生产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联系人列表和过滤PATCH

>

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

基本联系人清单很简单：

但是，稳健的API支持高级查询：此示例通过

>进行过滤，在

>或

中搜索，使用

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

>，按

进行排序，然后选择特定字段。 该实施涉及对输入进行消毒和动态构建数据库查询：>

$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中文网其他相关文章！