本文档是参考网上的然后根据公司需要对代码进行了抽取和优化(主要是加了标题栏和对输出进行了格式化输出,更换呢了页面渲染方式(改为直接使用php进行渲染,原来的是使用了模板引擎),可读性较好),配置简单,读取方便,和项目耦合性较小,只需要将api_view这个文件夹放到和项目同级就可以使用,接口文档只有100多k大小
1.配置控制器
按照上图格式写接口方法注释(主是在控制器上面和方法上)
2.将接口文档放置在和项目同级
注:上面3个事项目,最下面的是接口文档
3.配置接口文档配置文件
api_view\tool\config.php
上述配置文件的配置应该配置自己本地真实的配置,url为项目控制器所在的文件,这里有3个项目,其中javaApi控制器是放在了app项目下,所以会对这个文件做单独处理,就是下面的变动项
注:domain域名前不要加http://
4.主文件变动项
api_view\apiview.php
注:这个变动项,需要根据项目实际情况进行配置修改,其他文件区域不用修改
5.访问接口文档最终效果
下面是开发的接口调试文档,方便易用,都是读取的接口方法上的注释自动生成
时间: 2024-09-29 23:20:28