Yii2自动生成接口文档插件 yii2-doc-online

2017-8-29 liyangweb.com 李杨 PHP

    眼下前后端完全分离的开发模式是越来越火,好多项目都直接摒弃了常规的套页面方式,而改用前端控制主要业务逻辑,后端只提供接口数据的模式。这样一来,前后端就需要频繁的沟通接口含义。于是一个好的接口文档总是能事半功倍的,但是后台开发人员开发出接口后,写接口文档又是一个麻烦的事情,费时费力不说,当接口改动时,还要时刻记着去修改接口文档。

    介于本人平时需要开发很多接口,也要写很多文档,于是决定开发一款可以自动生成接口文档的小工具——yii2-doc-online,只要开发人员按照规范写好注释,那么接口文档就会自动生成了。

    代码已经开源与github,项目地址:https://github.com/kaopur/yii2-doc-online

    效果图见

标签: yii2 yii2-doc-online

评论:

代写essay
2017-10-27 20:41
支持楼主。
tengju
2017-10-18 13:34
yii2-doc-online未配置成功,'doconline' => [
                'item'           => 'frontend',
                'class'          => 'Kaopur\yii2_doc_online\Module',
                'defaultRoute'   => 'index',
                //默认控制器
                'appControllers' => true,
                //是否检测app\controllers命名空间下的控制器
                'suffix'         => '',
                //api后缀
                'prefix'         => '',
                //api前缀
                'modules'        => [  //需要生成文档的模块
                ],
            ],
根据教程,这样并不能为frontend生成api文档,求指导
liyangweb.com 李杨
2017-10-24 14:44
@tengju:之前兼容高级版有些问题,我会尽快修复,并发布新版本。谢谢关注
liyangweb.com 李杨
2017-10-25 09:43
@tengju:现已完美支持高级版和基础班,请升级至v2.0.0使用,配置文件略有变动,请知悉。

发表评论:

Powered by emlog 冀ICP备13011830号-1