如何解决 ApiPlatform 中实体未显示在 Swagger UI 的问题

如何解决 ApiPlatform 中实体未显示在 Swagger UI 的问题

在 Symfony 5.4 + ApiPlatform 环境中，自定义 Entity 无法出现在 Swagger UI 文档页面，通常是因使用了已废弃的注解命名空间 ApiPlatform\Core\Annotation\ApiResource，需升级为 ApiPlatform\Metadata\ApiResource。

在 Symfony 5.4 搭配 ApiPlatform 的环境里，你是否遇到过这样的情况：精心定义了一个实体（Entity），但 Swagger UI 文档页面却怎么也找不到它的踪影？别急，这多半不是配置的疑难杂症，而是一个“版本升级”带来的典型陷阱。

问题的根源，往往指向一个已经过时的注解命名空间：ApiPlatform\Core\Annotation\ApiResource。从 ApiPlatform 3.0 版本开始，框架已经全面迁移到了全新的元数据系统（ApiPlatform\Metadata），那个旧版的 ApiPlatform\Core\Annotation 命名空间不仅被标记为废弃，而且框架的自动扫描机制已经不再识别它了。

这意味着，即便你已经严格按照规范添加了 @ApiResource() 注解，也执行了缓存清除（bin/console cache:clear）并重启了开发服务器，只要导入的路径是错的，这个实体就会被 API Platform 的扫描流程“静默忽略”。结果就是，它既不会生成对应的 API 端点，也自然不会出现在 OpenAPI 文档（Swagger UI）里。

✅ 正确做法是更新命名空间导入

解决之道非常直接：将导入的命名空间更新到正确的路径。下面是一个清晰的示例：

// api/src/Entity/Review.php
id;
    }
}

⚠️ 注意事项

• 如果你的项目仍在使用 PHP 8.0 以下的版本，无法使用属性语法，那么请继续使用注解语法（/** @ApiResource */），但必须确保顶部的 use 语句指向 ApiPlatform\Metadata\ApiResource。
• 确保你的实体类位于正确的目录下，通常是 src/Entity/ 或 api/src/Entity/，并且该目录已被 Doctrine 的实体扫描配置（检查 doctrine.orm.mappings）所覆盖。
• 验证实体是否成功注册有两个实用的命令：运行 bin/console debug:router | grep api 可以查看生成的路由；运行 bin/console api:openapi:export 可以导出完整的 OpenAPI 规范，检查其中是否包含你的实体。
• 如果实体像示例中那样依赖另一个类（如 Book），请务必确认 App\Entity\Book 也同样使用了正确的 ApiPlatform\Metadata\ApiResource 并已正确定义。

? 总结

简单来说，从 ApiPlatform v3 开始，ApiResource 注解或属性必须从 ApiPlatform\Metadata 这个命名空间导入。继续沿用旧的命名空间，会导致实体“静默失效”——这可以说是新手在集成时，遇到“文档不显示”问题最常见的原因之一。完成这个关键的命名空间升级后，通常无需任何额外配置，只需刷新一下 Swagger UI 页面，你就能立刻看到对应的端点（例如 /api/reviews）出现在文档中了。