本项目为基于CmlPHP V2.x开发的一个api项目示例。包含了api开发的两个接口示例以及根据代码注释自动生成文档及自动测试的示例。
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
api 添加nonce验证功能 May 10, 2017
LICENSE imit Oct 26, 2016
README.md 添加自动测试说明 May 3, 2017
pre_user.sql 修改user表引擎为InnoDB。编码为utf8mb4; Feb 24, 2018

README.md

CmlPHP V2.x API项目示例

本项目为基于CmlPHP V2.x开发的一个api项目示例。包含了api开发的两个接口示例以及根据代码注释自动生成文档及自动测试的示例。

框架v2.7.7起支持api自动测试。

还不知道什么是CmlPHP?点这里了解

下载本示例之前请先下载 CmlPHPV2.x 项目推荐目录骨架.然后将本项目放到projxxx/Application下。

视频教程


主要的配置文件在 projxxx/Application/api/Config/api.php中

查看配置,我们看到在配置中我们配置了V1版本有注册、登录两个接口。

我们来看下其中的注册接口

我们看到了注释中的接口描述、参数、请求示例、返回成功/失败示例。

请修改api.php中相应的lookup_doc_key。 打开文档查看地址http://xxx/index.php/api/Bootstrap/doc/key/lookup_doc_key

layui主题v2.7.5起默认主题

bootstrap主题 我们看到了自动生成的接口文档。很简单吧。动起来吧。

开发过程中的目录及程序接口请参考 CmlPHP V2.x开发手册

框架v2.7.7起支持api自动测试。

通过web执行测试(容易超时)执行\Cml\Tools\Apidoc\AutoTest::run('api', '0+1+2');

在命令行下测试(不会超时) php index.php api-test --app=api --true_code=0+1+2

以上的参数0+1+2意思是接口返回的code除了0、1、2外其它的code均为失败