基于ThinkPHP5 基础上开发的一个简单的restful api ,带权限验证等
ThinkPHP5的运行环境要求PHP5.4以上。
详细开发文档参考 ThinkPHP5完全开发手册
初始的目录结构如下:
www WEB部署目录(或者子目录)
├─application 应用目录
│ ├─common 公共模块目录(可以更改)
│ ├─api 接口目录
│ │ ├─controller 控制器目录
│ │ │ ├─v1 版本1目录
| | | ├─v2 版本2目录
│ │ ├─Api.php 授权基类
│ │ ├─Oauth.php 授权验证
│ │ ├─Send.php 返回格式
│ │ ├─model 模型目录
| | ├─model
│ │ ├─view 视图目录
│ │ └─ ... 更多类库目录
│ │
│ ├─command.php 命令行工具配置文件
│ ├─common.php 公共函数文件
│ ├─config.php 公共配置文件
│ ├─route.php 路由配置文件
│ ├─tags.php 应用行为扩展定义文件
│ └─database.php 数据库配置文件
│
├─public WEB目录(对外访问目录)
│ ├─index.php 入口文件
│ ├─router.php 快速测试文件
│ └─.htaccess 用于apache的重写
│
├─thinkphp 框架系统目录
│ ├─lang 语言文件目录
│ ├─library 框架类库目录
│ │ ├─think Think类库包目录
│ │ └─traits 系统Trait目录
│ │
│ ├─tpl 系统模板目录
│ ├─base.php 基础定义文件
│ ├─console.php 控制台入口文件
│ ├─convention.php 框架惯例配置文件
│ ├─helper.php 助手函数文件
│ ├─phpunit.xml phpunit配置文件
│ └─start.php 框架入口文件
│
├─extend 扩展类库目录
├─runtime 应用的运行时目录(可写,可定制)
├─vendor 第三方类库目录(Composer依赖库)
├─build.php 自动生成定义文件(参考)
├─composer.json composer 定义文件
├─LICENSE.txt 授权说明文件
├─README.md README 文件
├─think 命令行入口文件
- 访问相应的url,例如:http://localhost/tp5test/public/index.php/v1/user
- DEMO: user控制器是继承了Api父类,会在初始化检测user控制器定义的访问限制 $restMethodList = 'get|post|put';
- 在Api类中,会有方法checkAuth()检测用户是否有权限调用接口
- checkAuth方法会调用Oauth类中的鉴权,$baseAuth = Factory::getInstance(\app\api\controller\OAuth::class);
- 根据用户端传递过来的app_key生成或者获取缓存中的access_token,接口地址:/api/v1/token/access_token
- 提交参数app_key和access_token进行对比,如果true,则可以调用user中的各种方法,否则返回不能调用原因
- 生成access_token,缓存access_token等相关逻辑在v1/Token.php代码中,使用的是本地缓存,如果需要使用数据库或者redis请查询相关注释说明