PHP API文档管理系统

https://github.com/ares333/php-doc-system.git

关于

项目已经大量用在生产环境。

API文档编写是非常重要的一项工作,但是编写维护非常麻烦,本项目解决的问题是以最轻松的方式维护n个接口,每个接口n个版本, 尤其适合大量接口的使用情境。

原理是解析固定格式的txt文件实时全自动生成文档,txt文件大量使用继承、递归、前缀、替换等等。

需求

PHP: >=5.3

ext-yaf: >=2.3.3

安装

composer create-project ares333/api-doc
  1. php ini: yaf.use_namespace = 1
  2. 绑定public目录为web服务器的入口
  3. Enjoy!

特性

  1. 无需数据库,可以用svn记录版本。
  2. 编写非常简便,所有枯燥的工作全部由机器完成。
  3. 支持非常多的自定义语法。
  4. 以非常便捷的方式实现继承、加前缀、后缀等各种高级功能。

Demo

http://demo-apidoc.phpdr.net
用户名:admin
密码:admin

联系我们

QQ群:424844502

PHP API文档管理系统》上有1条评论

发表评论

电子邮件地址不会被公开。

*