TRR 立志做最簡單、易上手、易擴展、易維護的TP反射註釋路由架構

簡介

TRR 開源地址

Github: https://github.com/china-wang...
Gitee: https://gitee.com/china_wangy...
博客：https://china-wangyu.github.io/

TRR 是什麼？

TRR 是 ThinkPHP51 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功能開發、接口開發更加簡單、迅捷。

想讓更多的朋友更加專注於業務開發，不再反覆去做路由添加、修改，接口文檔編寫等一些列的問題

我們只想你的項目更快、更穩定、更以維護的成型。

使用須知

在使用TRR時必定會用到的技能，你得做一個評估，查看自己是否可以無障礙使用。

涉及技術或框架

• PHP7.1 一種支持熱編譯的腳本語言

  你需要熟練掌握 PHP7.1 相關知識點，如果你精通此技能那就再好不過了，不精通也沒關係，請根據我收集的教程和資料進行學習

  • PHP 官方文檔: https://php.net/manual/zh/
  • 【極客學院】PHP全套教學視頻: https://www.bilibili.com/video/av10274152?from=search&seid=2228250606023131784
  • 韓順平php從入門到精通: https://pan.baidu.com/s/1YDQo... 提取碼: 6hyy
• 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 命令行裏使用以下命令

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

效果如下，就代表你啓動內置服務成功了

# 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

5. 瀏覽器訪問

訪問地址: 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。