api文档的安装

来源:互联网 发布:淘宝避开同款教程 编辑:程序博客网 时间:2024/06/12 19:51
api的安装:
1、https://nodejs.org/en/  下载文件安装
   http://apidocjs.com/    参照文档安装
2、在phpstrom下的Api文件中写注释   参照文档写,如下:
3、在phpstrom下执行 apidoc -i app/Http/Controllers/Api -o public/apidoc  每写完一次执行一次
4、在项目下新建apidoc.json文件如下:
{
    "name": "计时系统API",
    "version": "1.0.0",
    "description": "Timing System Api",
    "title": "计时系统API",
    "url" : "http://app.stjp360.com/api"
}
5、访问:你的域名/apidoc/index.html




/**
     * @api {put} /authorizations/current 刷新token(refresh token)
     * @apiDescription 刷新token(refresh token)
     * @apiSampleRequest /api/authorizations/current
     *
     * @apiGroup Auth
     * @apiPermission JWT
     * @apiVersion 1.0.0
     * @apiHeader {String} Authorization 用户旧的jwt-token, value已Bearer开头
     * @apiHeaderExample {json} Header-Example:
     *     {
     *       "Authorization": "Bearer 


eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6XC9cL21vYmlsZS5kZWZhcmEuY29tXC9hdXRoXC90b2tlbiIsImlhd


CI6IjE0NDU0MjY0MTAiLCJleHAiOiIxNDQ1NjQyNDIxIiwibmJmIjoiMTQ0NTQyNjQyMSIsImp0aSI6Ijk3OTRjMTljYTk1NTdkNDQyYzBiMzk0ZjI2N2Q


zMTMxIn0.9UPMTxo3_PudxTWldsf4ag0PHq1rK8yO9e5vqdwRZLY"
     *     }
     * @apiSuccessExample {json} Success-Response:
     *     HTTP/1.1 200 OK
     *   {
     *       "message": "",
     *       "status_code": 200,
     *       "data": {
     *           "token": 


"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vZGV2LmpzX2FwaS5jb20vYXBpL2F1dGhvcml6YXRpb25zIiwiaWF0IjoxNDkx


OTg3MDQ1LCJleHAiOjE0OTE5OTQyNDUsIm5iZiI6MTQ5MTk4NzA0NSwianRpIjoibkQ4NndDelNHTkV2Qk1pZSIsInN1YiI6MX0.uKYhJzKPC5Y-


bJEwgBoJ7xJe-EGpgOLSPpSTFndb8nE",
     *           "expired_at": "2017-04-12 10:50:45",
     *           "refresh_expired_at": "2017-04-26 08:50:45"
     *       }
     *   }
     */
原创粉丝点击