一开始应用PHPDocumentor生成接口文档,然而,感觉有点不够不便,后换成了apidoc.
装置
npm install apidoc -g或者应用yarn装置
yarn global add apidoc配置(apidoc.json)
每次导出接口文档都必须要让apidoc读取到apidoc.json文件(如果未增加配置文件，导出报错)，你能够在你我的项目的根目录下增加apidoc.json文件，这个文件次要蕴含一些我的项目的形容信息，比方题目、简短的形容、版本等，你也能够退出一些可选的配置项，比方页眉、页脚、模板等。apidoc.json
{ "name": "零碎接口文档", "version": "0.0.1", "description": "文档总形容", "title": "apidoc浏览器自定义题目", "url" : "文档url地址"}我的--order排序
{ "name": "平安质量检查ServiceAPIs", "version": "1.0.0", "description": "平安质量检查接口文档", "title": "API接口文档", "url": "http://safety.local:8889", "sampleUrl": "http://safety.local:8889", "order": [ "根底接口", "myWorkbench", "查看流动", "getActivity", "getActivityInfo", "addActivityFile", "getRectify", "getInfoList", "handleActivity", "searchAccount" ]}示例:
/** * @api {GET} /api.php?m=check&a=getActivity 查看所有查看流动列表 * @apiName getActivity * @apiGroup 查看流动 * @apiDescription 查看流动列表 * * @apiParam {String} token="s2iph9ik" 用户token * @apiParam {Number} adminid=3 用户id * @apiParam {Number=0,1,2,3,4} [type=0] 流动性质 0默认 1专项查看 2综合查看 3月度查看 4季度查看 * @apiParam {Number=0,1,2,3} [status=0] 查看活动状态 0未开始 1进行中 2已实现 3已勾销 * @apiParam {Number} [page=1] 页数 * @apiParam {Number} [num=10] 每页展现数量 * * @apiSuccess {Number} code 返回信息码 200 示意申请胜利 * @apiSuccess {String} msg 返回阐明信息 * @apiSuccess {boolen} success 申请胜利 * @apiSuccess {json} data 胜利数据 * @apiSuccess {Number} activity_record_num 问题记录数量 * * @apiSuccessExample Success-Response: * HTTP/1.1 200 OK * * { * "code": 200, * "msg": "", * "data": [{ * "id": "6", * "title": "2020年第二季度综合查看", * "property": "专项查看", * "check_project": "", * "dept": "xxxx部", * "check_range": "xx标段,xx标段", * "check_status": "0", * "start_time": "2020-08-19", * "end_time": "2020-08-31", * "add_time": "2020-09-01 09:00:49", * "summary": "查看查看", * "remark": "", * "file": "17", * "check_name": "bim", * "check_id": "13", * "check_phone": "17611241011", * "uid": "3", * "issue_status": "已整改回复", * "file_info": [{ * "filename": "创优网上填报零碎.docx", * "filepath": "upload/2020-05/22_12131327.docx" * }], * "activity_record_num": 2 * }], * "success": true * } * * @apiSampleRequest /api.php?m=check&a=getActivity */成果:
其余的解释请查看这篇文章吧:
apiDoc详解