讲师中心 微信公众号

工具推荐

视频效率加速
Laper
Laper

剧本策划到成片协作

立刻MV
立刻MV

低成本歌曲 MV、视频生成

AniShort
AniShort

AI短剧协同制作平台

Seko
Seko

AI短剧一键生成成片

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

秋磊吖_4822

秋磊吖_4822

发布时间:2026-04-11 09:18:15

|

414人浏览过

|

来源于php中文网

原创

如何解决 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\metadata\apiresource`。

ApiPlatform 自 3.0 版本起全面迁移至新的元数据系统(ApiPlatform\Metadata),旧版 ApiPlatform\Core\Annotation 已被弃用且不再被自动识别。即使你已正确添加 @ApiResource()、清除缓存(bin/console cache:clear)并重启开发服务器,若注解导入路径错误,该实体仍不会被 API Platform 扫描和注册,导致其完全不出现在 OpenAPI 文档(Swagger UI)中。

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

// api/src/Entity/Review.php
<?php

namespace App\Entity;

use ApiPlatform\Metadata\ApiResource; // ✅ 替换为新命名空间
use Doctrine\ORM\Mapping as ORM;

#[ApiResource] // 推荐使用 PHP 8+ 属性语法(Attribute)
class Review
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    private ?int $id = null;

    #[ORM\Column(type: 'integer')]
    public int $rating = 0;

    #[ORM\Column(type: 'text')]
    public string $body = '';

    #[ORM\Column(type: 'string', length: 255)]
    public string $author = '';

    #[ORM\Column(type: 'datetime_immutable', nullable: true)]
    public ?\DateTimeInterface $publicationDate = null;

    #[ORM\ManyToOne(targetEntity: Book::class)]
    public ?Book $book = null;

    public function getId(): ?int
    {
        return $this->id;
    }
}

⚠️ 注意事项:

  • 若项目仍在使用 PHP 必须使用 use ApiPlatform\Metadata\ApiResource;
  • 确保实体类位于 src/Entity/(或 api/src/Entity/)且被 Doctrine 实体扫描器覆盖(检查 doctrine.orm.mappings 配置)
  • 运行 bin/console debug:router | grep api 和 bin/console api:openapi:export 可验证实体是否已被注册
  • 若依赖 Book 类,请确保 App\Entity\Book 同样使用 ApiPlatform\Metadata\ApiResource 并已正确定义

? 总结:从 ApiPlatform v3 开始,ApiResource 必须从 ApiPlatform\Metadata 导入;沿用旧命名空间将导致实体静默失效——这是新手最常见的“文档不显示”原因。升级后无需额外配置,刷新 Swagger UI 即可立即看到 /api/reviews 等端点。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

12484

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

7201

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2235

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

4528

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

5254

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

4131

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

5977

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

4682

2023.11.13

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

40

2026.11.06

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn