如何在Sulu Articles API中获取自定义images属性

我之前在使用Sulu + Articles Bundle时也碰到过一模一样的问题——自定义字段明明在模板里配置好了，API请求却死活不返回。结合我的排查经验，给你几个可行的解决方向：

1. 给自定义字段添加序列化组配置 #

Sulu的API依赖Symfony的序列化组件，自定义字段需要明确指定序列化组才能被API返回。你可以直接在模板的images字段里添加serializer_groups参数：

<property name="images" type="media_selection">
    <meta>
        <title lang="en">Images</title>
    </meta>
    <params>
        <!-- 保留你已有的params配置 -->
        <param name="types" value="image,video"/>
        <!-- ... 其他现有param ... -->
        
        <!-- 添加序列化组配置 -->
        <param name="serializer_groups" type="collection">
            <param name="api"/>
            <param name="frontend"/>
        </param>
    </params>
</property>

这个配置会把images字段加入到api和frontend这两个序列化组中，而Articles API默认会使用这些组来序列化返回数据。

2. 调整API请求参数，添加expand参数 #

media_selection类型属于关联字段（关联到媒体库的资源），默认不会自动加载关联数据。你需要在请求URL中添加expand=images参数来触发关联数据的加载：

GET http://sulu.test/admin/api/articles?sortBy=authored&sortOrder=desc&locale=en&type=article&fields=id,images,typeTranslation,title,changerFullName,authorFullName,changed,authored&limit=20&expand=images

注意：expand参数的值要和你自定义字段的名称（这里是images）完全一致。

3. 清除缓存并重新发布文章 #

修改模板配置后，一定要清除Sulu和Symfony的缓存，避免旧配置生效：

# 清除开发环境缓存
bin/console cache:clear --env=dev

# 清除生产环境缓存
bin/console cache:clear --env=prod

另外，对于已经发布的文章，建议重新保存并发布一次，确保系统更新了文章的字段数据，新的配置才能对已有文章生效。

4. 检查全局序列化组配置（可选） #

如果上面的步骤没生效，你可以在config/packages/sulu_article.yaml里检查全局的序列化组配置，确保api组被包含在内：

sulu_article:
    serialization_groups:
        article:
            - 'api'
            - 'frontend'
            # 可以添加其他需要的组

按照这几个步骤操作后，你的API应该就能正确返回images字段了。

内容的提问来源于stack exchange，提问作者JohnnyAce