api文档的安装

24 篇文章 0 订阅
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"
     *       }
     *   }
     */
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Laravel技术社区

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值