PHP API文档管理系统

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

API文档编写是非常重要的一项工作,但是编写维护非常麻烦,本项目的解决的问题是以最轻松的方式维护n个接口,每个接口n个版本。原理是解析固定格式的txt文件实时全自动生成文档,大量使用继承、递归、前缀、替换等等。

安装

  1. composer install
  2. 绑定www服务器的入口目录为本项目的public目录
  3. 现在应该可以访问了

特性

  1. 无需数据库。
  2. 编写非常简便,所有枯燥的工作全部由机器完成。
  3. 支持非常多的格式。
  4. 以非常便捷的方式实现继承,加前缀,后缀等等各种高级功能。

Demo

http://doc.phpdr.net
用户名:admin
密码:admin

用法

语法说明文件查看doc/Api.txt
Demo使用的数据文件在app/data/doc/api
看Demo和文档基本就会用

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

发表评论

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

*