同步操作将从 嗝嗝/TRR 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
TRR 是 ThinkPHP51 Reflection Restful API
(注:API设计风格) 的字母第一个字符大写后拼接而来,
从ThinkPHP51 Reflection Restful API
全称可以看出来,
这套接口框架设计主要围绕反射
来做Restful API接口设计
的。
ThinkPHP5.1
能做什么。ThinkPHP5.1
能做的都能做,而且在反射路由方面,我们比ThinkPHP5.1
更为专注专注做什么:
我们专注研究PHP反射相关的知识点,想让PHP
web
功能开发、接口开发更加简单、迅捷。
想让更多的朋友更加专注于业务开发,不再反复去做路由添加、修改,接口文档编写等一些列的问题
我们只想你的项目更快、更稳定、更以维护的成型。
在使用TRR时必定会用到的技能,你得做一个评估,查看自己是否可以无障碍使用。
PHP7.1
一种支持热编译的脚本语言
你需要熟练掌握PHP7.1
相关知识点,如果你精通此技能那就再好不过了,不精通也没关系,请根据我收集的教程和资料进行学习
PHP
官方文档: https://php.net/manual/zh/
ThinkPHP5.1
:中国比较流行且会一直流行的PHP框架
如果你对ThinkPHP5.1
不太了解,或者一知半解,请到官方文档进行查阅,补充效果知识点。
官方文档
Reflection
PHP 反射机制
如果你对 PHP 反射相关知识点不是很了解,推荐先进行了解一下
PHP
官方文档: https://php.net/manual/zh/book.reflection.php
ThinkPHP5.1
反射相关知识点: https://www.kancloud.cn/manual/thinkphp5_1/469333
wangyu/reflex-core composer
扩展使用: https://github.com/china-wangyu/php-reflex-core
Restful API
是一种API接口设计风格或者说潮流
如果你对 Restful API
还不了解,我收集了一些比较好的译文。
-RESTful
架构风格概述: https://juejin.im/entry/57c7a323a633bd006cfc1d84
Restful API PHP
的学习视频: https://www.imooc.com/learn/811
Composer
是php
最为流行和使用最多的第三方扩展库
推荐使用 阿里云
composer
镜像源 1分钟内快速同步,稳定可靠
如果你对 Composer
了解不够,请仔细阅读我收集的一些资料。
composer
入门中文文档: https://docs.phpcomposer.com/
composer
安装文档: https://packagist.laravel-china.org/
composer
更换国内源: https://segmentfault.com/a/1190000019651993
到此,相信你对TRR有了一定的了解了,对TRR项目需要用到的技术有个清晰的了解,如果你还是不太清楚,请继续在网上寻找资源学习吧, 加油,明天会更美丽。
在你项目文件夹内,点击鼠标右键 打开 git Bash Here
在 git bash
命令行里使用以下命令
PHP
环境(version: 7.1
及以上)Git
环境(version: 1.8
及以上)Composer
环境(version: 1.8
及以上)获取项目源码
git clone https://github.com/china-wangyu/TRR.git
在进入项目目录
cd TRR
安装依赖
composer install
为了防止PHP各种集成和非集成软件环境问题,本项目开发期间希望各位使用 ThinkPHP5.1
内置服务
有关文档: https://www.kancloud.cn/manual/thinkphp5_1/518750
php think run -H 127.0.0.1 -p 8000
效果如下,就代表你启动内置服务成功了
F:\project\open-source-object\Trr\2019-7-6\TRR [master ≡ +0 ~217 -0 !]
λ php think run -H 127.0.0.1 -p 8000
ThinkPHP Development server is started On <http://127.0.0.1:8000/>
You can exit with `CTRL-C`
Document root is: F:\project\open-source-object\Trr\2019-7-6\TRR\public
[Sat Jul 6 17:42:19 2019] 127.0.0.1:57509 [200]: /
[Sat Jul 6 17:42:20 2019] 127.0.0.1:57510 [200]: /favicon.ico
访问地址: http://127.0.0.1:8000/
JWT
的 Token
route: http://127.0.0.1:8000/auth?name=trr&password=trr
method: post
返回效果:
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUUlIiLCJpYXQiOjE1NjI0MDk2MDgsImV4cCI6MTU2MjQxNjgwOCwidXVpZCI6MTAwLCJzaWduYXR1cmUiOiJ0cnIifQ.MXXGcK2xjAznzcC-PQ66dRAo30Wn1poNLCNbFcO7ORA",
"refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUUlIiLCJpYXQiOjE1NjI0MDk2MDgsInV1aWQiOjEwMCwic2lnbmF0dXJlIjoidHJyIn0.RBs5iOSTjC89Z6H4CPl9tNyXHOhtmuPQPd7JOB_n5JY"
}
JWT
的 Token
route: http://127.0.0.1:8000/auth/refresh
method: get
header: 需要设置:authorization
返回效果:
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJUUlIiLCJpYXQiOjE1NjI0MTE0OTMsImV4cCI6MTU2MjQxODY5MywidXVpZCI6MTAwLCJzaWduYXR1cmUiOiJ0cnIifQ.4siwrzghm-r_SZNz-SUwkI3Of-9Hx9vOHMYdHXjf7rA"
}
markdown
格式的 API
文档命令行生成
在项目根目录下打开 cmd
或 终端
输入以下命令
php think trr:build
效果如下,代表文档生成成功:
F:\project\open-source-object\Trr\2019-7-6\TRR [master ≡ +0 ~217 -0 !]
λ php think trr:build
Successful. Output Document Successful . File Path :api-md.md
使用 WangYu/Doc
类生成文档
实现代码如下:
<?php
namespace app\index\controller;
class Index
{
// 创建 API Markdown 文档
public function build()
{
$doc = new \WangYu\Doc('api 模块','生成的API文档名称');
$doc->execute();
}
}
访问Index
类下的build
方法,就会在项目根目录
创建你的API文档了
由于目前TRR目前还处在不断迭代更新阶段,TP5.1版本也在持续跟进,所以本课程的内容也会随着适配的进度而增加或者调整。
局限于个人技术水平和写作能力,如果教程中有哪些地方读者觉得不对或者看不懂需要再讲仔细些可以随时提出。
读者对本教程或者GitHub项目有任何疑问、建议都可以在作者GitHub仓库提个issues
或
加【TRR 官方群】QQ群: 860613750
如果你觉得本项目帮助到你,想请作者喝杯茶 , 请扫码打赏任意金额
或者
TRR 遵循 MIT 开源协议发布,并提供免费使用。
本项目包含的第三方源码和二进制文件之版权信息另行标注。
版权所有Copyright © 2006-2019 by TRR
All rights reserved。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。