php - ReSTLer:作为参数的复杂对象类型

Question

你好 ReSTLer 的 friend 们，

我目前正在尝试切换到 ReSTLer 作为我们的主要 Rest-Framework。真正促使我做出决定的是 Swagger 的合规性。我发现为成长中的系统自动生成一个很好的文档非常重要。

所以，我的问题是我似乎无法找到一种方法来使用“复杂对象”作为 swagger 中指定的后置参数:https://github.com/wordnik/swagger-core/wiki/Parameters .

当然，您可以只从“post assoc array”中检索所有内容，然后根据对象结构进行验证，但这不会被记录下来，客户也不知道他期望的结构是什么。因此，我将不得不编写规范。手动...

示例:

/**
 * Create a new Account, based on the structure of the Account Object
 *
 * @param Account $account {@from body}
 *
 * @return string
 *
 */
protected function post(Account $account){...}

这将简单地作为未定义的“对象”放在 resource.json 中，而不是作为链接到 Account 对象的“复杂类型”(顺便说一句，这非常适合返回的对象)

资源.json

"parameters": [
    {
    "name": "REQUEST_BODY",
    "description": "Paste JSON data here with the following property.<hr/><mark>account</mark> <i>(required)</i>: add <mark>@param {type} $account {comment}</mark> to describe here",
    "paramType": "body",
    "required": true,
    "allowMultiple": false,
    "dataType": "Object",
    "defaultValue": "{\n    \"account\": \"\"\n}"
    }
    ],

我是否遗漏了什么或者该功能未实现？

在此先感谢您帮助我!

更新:我设法直接从 post 方法 nativly 中获取序列化对象，但我认为这是不可能的。这并没有解决自动文档问题，但仍然非常有值(value)。

Answer 1

ReSTLer 3 RC4 昨天发布，带有自定义类参数功能

阅读http://restler3.luracast.com/param.html#type示例和测试代码