Metrics
0
Watch 2 Star 13 Fork 5

china_wangyu / TRRPHPMIT

Sign up for free
Explore and code with more than 2 million developers,Free private repositories !:)
Sign up
A Simple and Practical Annotation Routing RESTful API Implemented by ThinkHP 5.1 , 由thinkhp 5.1实现的简单实用的注释路由RESTfulAPI spread retract

https://github.com/china-wangyu/TRR

Clone or download
Loading...
README.md

TRR
TRR

php version ThinkPHP version LISENCE

简介

TRR 是什么?

TRRThinkPHP51 Reflection Restful API(注:API设计风格) 的字母第一个字符大写后拼接而来, 从ThinkPHP51 Reflection Restful API全称可以看出来, 这套接口框架设计主要围绕反射来做Restful API接口设计的。

TRR 可以做什么?

  1. 你可以先了解一下ThinkPHP5.1能做什么。
  2. ThinkPHP5.1 能做的都能做,而且在反射路由方面,我们比ThinkPHP5.1更为专注

专注做什么:

  • 反射 API 接口路由
  • 反射 API 接口文档生成
  • 反射 API 参数快速验证
  • 让接口开发更简单、直观、迅捷
  • 让接口维护更轻松、明了、快速

我们专注研究PHP反射相关的知识点,想让PHP web功能开发、接口开发更加简单、迅捷。

想让更多的朋友更加专注于业务开发,不再反复去做路由添加、修改,接口文档编写等一些列的问题

我们只想你的项目更快、更稳定、更以维护的成型。

使用文档

标注: master 分支属于 TRR-v0.0.2

TRR-v0.0.1文档:👉 点我了解

TRR-v0.0.2文档:👉 点我了解

未完待续·····

快速开始

在你项目文件夹内,点击鼠标右键 打开 git Bash Here

git bash 命令行里使用以下命令

1. 检查服务端必备环境

  • 安装PHP环境(version: 7.1 及以上)
  • 安装Git环境(version: 1.8 及以上)
  • 安装Composer环境(version: 1.8 及以上)

2. 获取项目源码

获取项目源码

git clone https://github.com/china-wangyu/TRR.git

在进入项目目录

cd TRR

3. 安装项目依赖

安装依赖

composer install

4. 运行项目

为了防止PHP各种集成和非集成软件环境问题,本项目开发期间希望各位使用 ThinkPHP5.1内置服务 有关文档: https://www.kancloud.cn/manual/thinkphp5_1/518750

php think run -H 127.0.0.1 -p 8000

效果如下,就代表你启动内置服务成功了

wy@Mac TRR (master) $ 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: /Users/wy/Desktop/TRR/public
[Mon Jul 29 16:39:08 2019] Failed to listen on 127.0.0.1:8000 (reason: Address already in use)

5. 浏览器访问

然后你可以直接在浏览器里面访问

http://127.0.0.1:8000/

其他功能

创建 JWTToken

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"
}

刷新 JWTToken

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:doc

    效果如下,代表文档生成成功:

    F:\project\open-source-object\Trr\2019-7-6\TRR [master ≡ +0 ~217 -0 !]
    λ  php think trr:doc
    Successful. Output Document Successful . File Path :api-doc.html

注意 ! 注意 ! 注意 !

演示地址

维护与提问

更新

由于目前TRR目前还处在不断迭代更新阶段,TP5.1版本也在持续跟进,所以本文档的内容也会随着适配的进度而增加或者调整。

项目更新记录,可以在CHANGELOG.md查看

完善

局限于个人技术水平和写作能力,如果教程中有哪些地方读者觉得不对或者看不懂需要再讲仔细些可以随时提出。

催更、提问与交流

读者对本教程或者GitHub项目有任何疑问、建议都可以在作者GitHub仓库提个issues

加【TRR 官方群】QQ群: 860613750

请我喝茶

如果你觉得本项目帮助到你,想请作者喝杯茶 , 请扫码打赏任意金额

请作者喝茶

版权信息

TRR 遵循 MIT 开源协议发布,并提供免费使用。

本项目包含的第三方源码和二进制文件之版权信息另行标注。

版权所有Copyright © 2006-2019 by TRR

All rights reserved。

Comments ( 0 )

You need to Sign in for post a comment

Help Search