如何为swagger正确注释此函数?

如何为swagger正确注释此函数?,swagger,swagger-php,Swagger,Swagger Php,我正在尝试使用Slim编写一个小Api。我想把它很好地记录下来,所以我安装了swagger php和UI,并在最后几天对其进行了调查。由于某些原因,我的petstore演示缺少所有的后期注释。我的API如下例所示: addWine()函数的招摇过市注释是什么样子的? 既然函数(最后一个insert id)不是模型,我该如何注释它的结果 举个例子就太好了。 谢谢这样就可以了。很可能不是这样的,但做的正是我想要的 /** * @package * @category * @subpackage *

我正在尝试使用Slim编写一个小Api。我想把它很好地记录下来,所以我安装了swagger php和UI,并在最后几天对其进行了调查。由于某些原因,我的petstore演示缺少所有的后期注释。我的API如下例所示:

addWine()函数的招摇过市注释是什么样子的? 既然函数(最后一个insert id)不是模型,我该如何注释它的结果

举个例子就太好了。
谢谢

这样就可以了。很可能不是这样的,但做的正是我想要的

/**
* @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")
 */