API-Explorer/Swagger에서 응답 개체 설명

Question

나는 Swagger-UI의 포크 인 Restler 3's API-Explorer을 사용하고 있으며 API가 반환하는 응답 JSON 개체를 문서화하거나 설명하는 효과적인 방법을 찾은 사람이 있는지 궁금해하고 있습니다. 분명히 "선들 사이에서 읽으십시오"와 같은 방식의 일부는 API를 대화식으로 시도 할 때 사용할 수 있지만 좀 더 자세하게 응답 구조를 나타낼 수있는 방법이 필요합니다. 아무도 이것으로 무엇을 생각해 냈습니까?

Answer 1

당신은 @return PHPDoc 코멘트를 사용합니다. 예를 들어

, 당신은 응답 정보를 찾을 수

GET authors.json/{id} 

의 explorer에서 Rate Limiting Example을 살펴 목록 그것은로 설정 한 다음 클래스에서 오는

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