Я использую API-Explorer от Restler 3, который является ответвлением Swagger-UI, и мне интересно, нашел ли кто-нибудь эффективный способ документирования/описания объекта ответа JSON, который возвращает API. Очевидно, что кое-что из этого — в виде «читать между строк» — доступно, когда вы в интерактивном режиме пробуете API, но я хотел бы каким-то образом указать более подробно структуру ответа. Кто-нибудь придумал что-нибудь для этого?
Описание объекта ответа в API-Explorer/Swagger
Ответы (1)
Вы делаете это с помощью комментария @return
PHPDoc.
Например, взгляните на Пример ограничения скорости в проводник для
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='[email protected]';
}
person
Community
schedule
22.01.2013
Отличный пример. Это именно то, что я искал!
- person ken; 22.01.2013
По какой-то причине моя собственная версия не предоставляет информацию об ответе (она также не показывает информацию о типе переменных). Наверное, что-то накосячило с моей стороны. Есть идеи?
- person ken; 22.01.2013
Кстати, у меня есть последняя версия git из вашей основной ветки Restler-API-Explorer (0d79cd8). Хотя я немного новичок в git, и, поскольку я разветвил его и сохранил ссылку на ваш репозиторий через удаленный апстрим, я немного беспокоюсь, что сделал что-то глупое, когда сливал свои изменения. Мои изменения были ОЧЕНЬ простыми.
- person ken; 22.01.2013
Я проверю это, пока использую проводник, который идет с примерами
- person Arul Kumaran; 23.01.2013
Да, я пришел к этой идее прошлой ночью, и она действительно улучшает ситуацию, но она не идеальна... типы появляются, но все они перечислены как строки, и предварительное заполнение JSON переменных BODY не происходит.
- person ken; 23.01.2013
В последней версии я не считаю, что
@return Author
достаточно; однако @return Author {@type Author}
похоже приводит к желаемому результату
- person Jack; 07.08.2015