Как правильно аннотировать эту функцию для чванства?

Я пытаюсь написать небольшой Api, используя Slim. Я хочу, чтобы это было хорошо задокументировано, поэтому я установил swagger-php и UI и исследовал его в последние дни. По какой-то причине в моей демо-версии магазина нет всех аннотаций к сообщениям. Мой API будет выглядеть в этом примере:

http://coenraets.org/blog/2011/12/restful-services-with-jquery-php-and-the-slim-framework/

Как будут выглядеть аннотации чванства для функции addWine ()? Как мне аннотировать результат функции (последний идентификатор вставки), если это не модель?

Пример был бы действительно замечательным. Спасибо


swagger swagger-php
person user2942586    schedule 03.05.2014    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Это сделало бы это. Скорее всего, я не хотел быть таким, но делал именно то, что хотел.

/**
* @package
* @category
* @subpackage
*
* @SWG\Resource(
*   apiVersion="1.0.0",
*   swaggerVersion="1.2",
*   basePath="http://myapi",
*   resourcePath="/hello",
*   description="Giving you your name in case you forgot it",
*   produces="['application/json','application/xml','text/plain','text/html']"
* )
*/

/**
 * @SWG\Api(
 *   path="/hello/{yourname}",
 *   @SWG\Operation(
 *     method="GET",
 *     summary="Gives you your name",
 *     notes="Returns your name",
 *     type="hello",
 *     nickname="yourname",
 *     @SWG\Parameter(
 *       name="yourname",
 *       description="Enter your name",
 *       required=true,
 *       type="text",
 *       paramType="path"
 *     ),
 *     @SWG\ResponseMessage(code=404, message="Bad, really bad name.")
 *   )
 * )
 *
     */ 

 /**
     * @package
     * @category
     * @subpackage
     *
     * @SWG\Model(id="hello",required="name")
     */

/**
 * @SWG\Property(name="name",type="string",description="Your name")
 */
person user2942586    schedule 04.05.2014