1.0 文档的书写 - Githubissues

easychen / LazyPHP4

LazyPHP4 , an API first framework for php developer

313 stars 66 forks source link

1.0 文档的书写 #3

Open easychen opened 10 years ago

easychen commented 10 years ago

包括以下内容：

设计理念和特色介绍（整理目前的ReadMe即可
快速起步（如何在各种环境上部署一个可用的LP4，包括 Windows、Linux、Mac以及SAE、BAE
使用手册（各部分的详细说明，以下是提纲
- 路由指定（参考flightphp的介绍，进行整合
- 文档生成（参考php-apidoc ，进行整合
- 参数验证（从ApiParams开始介绍，分析路由指定参数和方法绑定参数的不同和使用方法
- 结果和错误输入（如何通过send_result 和 send_error 输入结果，以及通过异常处理通用错误。还有通过send_json输出自定义格式结果
- 数据库使用（函数接口、对象接口。对象接口新增的结果处理方法，以及针对表的Ldo对象。
- 配置的设置和读取（这个和LP3一致
高级使用教程
- Composer的使用
- PHPUnit的使用
- Behat的使用
- Phinx的使用