当前位置: 首页 > 后端技术 > PHP

apidoc生成接口文档-PHP

时间:2023-03-29 22:05:29 PHP

一开始用PHPDocumentor生成接口文档,感觉有点不方便,后来换成了apidoc。安装npminstallapidoc-g或使用yarn安装yarn全局添加apidoc配置(apidoc.json)。每次导出接口文件,都要让apidoc读取apidoc.json文件(如果没有添加配置文件,导出会报错),可以在你的项目根目录下添加apidoc.json文件,该文件主要包含一些项目描述信息,如标题、简短描述、版本等,还可以添加一些可选的配置项,如页眉、页脚、模板等。apidoc.json{"name":"Systeminterfacedocument","version":"0.0.1","description":"文档的一般描述","title":"apidoc浏览器自定义标题","url":"文档url地址"}我的--ordersort{"name":"安全质检服务APIs","version":"1.0.0","description":"安全质检接口文档","title":"API接口文档","url":"http://safety.local:8889","sampleUrl":"http://safety.local:8889","order":["基本界面","myWorkbench","查看活动","getActivity","获取行为ivityInfo","addActivityFile","getRectify","getInfoList","handleActivity","searchAccount"]}示例:/***@api{GET}/api.php?m=check&a=getActivity查看所有检查活动列表*@apiNamegetActivity*@apiGroup检查活动列表*@apiDescription检查活动列表**@apiParam{String}token="s2iph9ik"用户令牌*@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问题记录数**@apiSuccessExampleSuccess-Response:*HTTP/1.1200OK**{*"code":200,*"msg":"",*"data":[{*"id":"6",*"title":"2020年二季度综合检查",*"property":"专项检查",*"check_project":"",*"dept":"xxxx部门",*"check_range":"xxsection,xxsection",*"check_status":"0",*"start_time":"2020-08-19",*"end_time":"2020-08-31",*"add_time":“2020-09-0109:00:49”,*“摘要”:“检查检查”,*“备注”:“”,*“文件”:“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-iwebmain/task/api/-o./apidoc/可以写成PHP文件,然后执行PHP脚本: