在API-Explorer/Swagger中描述響應對象

Question

我使用的是Restler 3's API-Explorer，它是Swagger-UI的一個分支，我想知道是否有人找到了記錄/描述API返回的響應JSON對象的有效方法。顯然，當你交互式地嘗試API時，其中的某些內容（如「在各行之間讀取」）可用，但我想用某種方式更詳細地指示響應的結構。有沒有人爲此提出過任何事情？

Answer 1

你可以用@return PHPDoc評論來做到這一點。

舉個例子，拿在explorer看看Rate Limiting Example爲

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'; 
}