如何查找包含serializer等参数的Ruby on Rails render API文档

你在Rails官方文档中找不到serializer、each_serializer、meta这几个参数的说明是正常的，这些都不是Rails框架原生支持的render参数，是第三方序列化gem active_model_serializers（常简称AMS）对Rails渲染流程扩展后新增的自定义参数。

Rails原生的render :json逻辑非常简单，本质是调用传入对象的to_json方法完成序列化，原生支持的参数确实只有你在ActionController::ApiRendering文档里看到的那些，没有任何和自定义序列化器相关的配置项。

当项目引入active_model_serializers之后，gem会通过钩子扩展Rails的render方法，你代码中用到的几个扩展参数作用分别是：

• serializer：指定顶层使用的序列化器类，示例中传入ActiveModel::Serializer::CollectionSerializer是明确告知AMS当前要序列化的是对象集合，需要用集合序列化器处理
• each_serializer：配合集合序列化器使用，指定集合内每一个单个对象对应的序列化器类，示例中RecSerializer就定义了每个rec对象的字段序列化规则
• meta：用于在序列化返回结果的最外层添加独立的元数据字段，通常用来放请求状态、分页信息这类不属于业务数据本身的全局信息

如果要确认这些参数的合法性和具体用法，查看对应版本的active_model_serializers官方文档即可。

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