Skip to content

Zjmainstay/php-doc-management

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

build status

关于

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

需求

PHP 5.4+
PHP Yaf 2.3.3+
php-yaf-library

安装

  1. 下载php-yaf-library到本地(比如/srv/www/php-yaf-library),在目录中执行composer install安装依赖。
  2. 安装yaf扩展并配置,yaf扩展的配置在php.ini或yaf.ini中
    yaf.library = "/srv/www/php-yaf-library"
    yaf.environ = "development"
  3. 绑定www服务器的入口目录为本项目的public目录
  4. 现在应该可以访问了,如果有问题见联系我们

联系我们

Email: admin@phpdr.com
QQ群:424844502

特性

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

Demo

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

用法

语法说明文件查看doc/Api.txt
Demo使用的数据文件在app/data/doc/api
看Demo和文档基本就会用,更深入问题讨论见联系我们

About

A powerful document management system written in php.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 52.3%
  • HTML 30.5%
  • JavaScript 15.3%
  • PHP 1.8%
  • Other 0.1%