在API-Explorer / Swagger中描述响应对象

Question

我正在使用Restler 3's API-Explorer这是Swagger-UI的分支，我想知道是否有人找到了记录/描述API返回的响应JSON对象的有效方法。显然，当您以交互方式尝试API时，可以使用其中一些 - 在“行间读取”方式 - 但我想要某种方式更详细地指示响应的结构。有没有人为此提出任何建议？

Answer 1

您可以使用@return PHPDoc评论来执行此操作。

例如，请查看Rate Limiting Example中的explorer

GET authors.json/{id}

您会找到响应信息列表

Author ( name: string, email: string )

它来自以下类设置为返回类型

<?php
/**
 * Dummy class, used only for creating swagger spec model (json schema)
 * look at the generated resources json to understand
 */
class Author
{
    public $name='Name';
    public $email='name@domain.com';
}