# cmlphp2.5-demo-api

**Repository Path**: iuyes/cmlphp2.5-demo-api

## Basic Information

- **Project Name**: cmlphp2.5-demo-api
- **Description**: 本项目为基于CmlPHP V2.x开发的一个api项目示例。包含了api开发的两个接口示例以及根据代码注释自动生成文档的示例。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 4
- **Created**: 2016-06-08
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CmlPHP V2.x API项目示例

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

还不知道什么是CmlPHP?[点这里了解](http://cmlphp.51beautylife.com/ "CmlPHP")

> 下载本示例之前请先下载 [CmlPHPV2.x 项目推荐目录骨架](http://git.oschina.net/linhecheng/cmlphp2.5-demo-proj).然后将本项目放到projxxx下。本示例使用了valitron验证插件，所以需要在composer.json require中加入 `"vlucas/valitron" : "*"` 然后执行   `composer update`。当然了如果你没有安装composer也可以直接下载我打包好的zip包(包含了项目目录骨架) [api_demo_zip](http://o7v4k1oiv.bkt.clouddn.com/cmlphpapidemo.zip)

[视频教程](http://v.youku.com/v_show/id_XMTQwNTc4MDk2OA==.html)

---

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

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

我们来看下其中的注册接口
![](http://o7v4k1oiv.bkt.clouddn.com/apidemo1.png)

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

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

![](http://o7v4k1oiv.bkt.clouddn.com/apidemo3.png)
我们看到了自动生成的接口文档。很简单吧。动起来吧。

开发过程中的目录及程序接口请参考 [CmlPHP V2.x开发手册](https://www.zybuluo.com/linhecheng/note/226146)