|
本帖最后由 ★わ浪漫少帅 于 2014年5月9日 15:52 编辑
现阶段本人已将该项目开源. 项目地址:https://github.com/ym1623/codeigniter_apidoc/ 文档:http://ym1623.github.io/codeigniter_apidoc/ 平时我们都需要为一些技术文档,接口文档而烦扰,该插件意在解决这些头疼的问题,支持ci所有版本,php版本>=5.0 现在暂时提供web版本的,以后会提供命令行版本的供大家使用。 使用: PHP复制代码 /** * @author ym * @group(name="docgroup", description="文档模块") */ class Doc extends CI_Controller { function __construct() { parent::__construct(); $this->load->library('phpdoc/apidoc'); } /** * @ApiDescription(section="User", method="get", description="Get information about user") * @ApiNotice(description="登录后,客户端要保存服务器种下的cookie来维护session") * @ApiSuccess(value="{'firstname' : 'ym', 'lastname' : '1623', 'lastLogin' : '2014-04-21'}") * @ApiExample(value="{'username' : 'ym', 'password' : '123456'}") * @ApiAccess(login="true") * @ApiParams(name="id", type="integer", is_selected=true, description="User id") * @ApiParams(name="sort", type="enum[asc,desc]", description="User data") * @ApiReturn(name="id", type="integer", description="User id") * @ApiReturn(name="sort", type="enum[asc,desc]", description="sort data") * @ApiReturn(name="page", type="integer", description="data of page") * @ApiReturn(name="count", type="integer", description="data of page") */ function build(){ $this->apidoc->build_doc(); } } 如上面的代码所示:class注释规则:
生成后的预览: markdown 首页预览: 详情页预览: HTML 首页预览: 详情页预览: html格式的完全是自适应屏幕的,可以直接用手机查看 具体使用方法及说明请查看文档:http://ym1623.github.io/codeigniter_apidoc/ 评分 | |
|
本帖最后由 Houis 于 2018年4月23日 15:45 编辑
CI3版本,报错如下: A PHP Error was encountered Severity: Notice Message: Undefined variable: content Filename: phpdoc/Apidoc.php Line Number: 50 应该是没有做function generateTemplate里面的循环,该如何解决? | |
|
| |
|
| |
|
很好很強大....
標記一下方便下次用 | |
|
| |
|
| |
|
嗯,谢谢支持!如果自己能写了模板的话可以分享出来! | |
|
厉害
| |