Sylius API 404 错误排查与启用指南

本文旨在解决 sylius 新安装后 api 接口返回 404 错误的问题。核心解决方案包括两方面：首先，需要明确启用 sylius api 功能，因为其在开发阶段默认可能未激活；其次，必须生成 jwt 认证所需的密钥对，以避免后续因认证失败导致的错误。通过这两个关键步骤，用户可以顺利地激活并使用 sylius 的各项 api 服务。

在 Sylius 的全新安装环境中，开发者可能会遇到一个常见的困扰：即使前端和管理后台运行正常，尝试调用 API 接口时却始终收到“404 Page not found”的错误响应。即便通过 php bin/console debug:router api 命令确认了 API 路由的存在，例如 /api/v2/docs，访问这些路由仍然会返回相同的 404 错误。这通常发生在 Apache2 和 MySQL 环境下，例如 Ubuntu 21.04 系统与 Sylius 1.10 版本。

要解决这个问题，需要执行两个关键配置步骤，以确保 Sylius API 的正确启用和功能完整性。

步骤一：启用 Sylius API 功能

Sylius 的 API 模块，尤其是在其仍在积极开发和完善阶段时，可能需要手动激活。这是导致 API 路由存在但无法访问的主要原因。

1. 编辑配置文件： 打开你的 Sylius 项目中的 config/packages/_sylius.yaml 文件。

2. 添加配置项： 在该文件中添加以下配置，明确启用 Sylius API：

   sylius_api:
       enabled: true

   登录后复制

   保存文件后，再次尝试访问 API 路由，你会发现原先的 404 错误应该已经消失。此时，API 路由能够被正确识别，但可能会遇到新的错误，例如与认证相关的提示。

步骤二：生成 JWT 密钥对

Sylius API 默认使用 JSON Web Token (JWT) 进行认证。在没有生成密钥对的情况下，API 调用将无法创建有效的签名 JWT，从而导致认证失败，并返回类似“Unable to create signed JWT from given configuration”的错误信息。

挖错网

一款支持文本、图片、视频纠错和AIGC检测的内容审核校对平台。

28

查看详情

1. 执行命令生成密钥： 通过命令行工具，运行以下命令来生成 JWT 密钥对。这个命令由 LexikJWTAuthenticationBundle 提供，它是 Sylius API 认证的基础。

   php bin/console lexik:jwt:generate-keypair

   登录后复制

   执行此命令后，系统会在项目的 config/jwt 目录下生成 private.pem 和 public.pem 两个文件，分别用于签名和验证 JWT。

验证与总结

完成上述两个步骤后，你的 Sylius API 应该已经完全启用并能够正常工作。你可以尝试访问 /api/v2/docs 或其他 API 端点，此时应该能看到预期的响应内容，而不是 404 错误或认证失败提示。

注意事项：

• 缓存清除：在修改配置后，为了确保更改生效，建议清除 Sylius 的缓存：php bin/console cache:clear。
• Web服务器配置：确保你的 Web 服务器（如 Apache 或 Nginx）已正确配置，将所有请求重写到 public/index.php。对于 Apache，这意味着 mod_rewrite 模块已启用，并且你的 VirtualHost 配置中包含正确的 AllowOverride All 和 RewriteRule 指令。
• 权限：确保 config/jwt 目录及其生成的文件具有正确的读写权限，以便 Web 服务器和 PHP 进程可以访问它们。

通过以上详细步骤，即使是 Sylius 初学者也能有效地解决 API 404 问题，并顺利启动其 API 开发之旅。

以上就是Sylius API 404 错误排查与启用指南的详细内容，更多请关注php中文网其它相关文章！