PHP7.2 + TP5.1 + Restful Api ,構建的API項目架構

PHP7.2 + TP5.1 + Restful Api ,構建的API項目架構

TP5.1 Restful Api

介紹

PHP7.2 + TP5.1 + Restful Api ,構建的API項目架構,支持API文檔輸出、API接口自檢、開啟API JWT模式、反射路由模式、API參數自檢等功能

為了本項目擁有更加直白與客觀的簡易性、閱讀性、實用性,所用的擴展和第三方代碼,均未考慮高度抽象和深度封裝,各位大大可以很簡單的看懂源碼和框架設計。

如果有需要或涉及到高併發的服務架構,可以在issues提出,或者留言也行,我將參考大家的意願,出一個版本或demo。

軟件架構

軟件架構說明

www WEB部署目錄(或者子目錄)
├─application 應用目錄
│ ├─api 接口模塊目錄(可以更改,但不建議:很麻煩,模塊裡面不建議寫模型和視圖)
│ │ ├─common.php 模塊函數文件(接口函數推薦寫在這裡)
│ │ ├─controller 控制器目錄
│ │ │ ├─v1 接口版本模塊
│ │ │ ├─v... 接口版本模塊
│ ├─common 公共模塊目錄(可以更改)

│ │
│ ├─command.php 命令行定義文件
│ ├─common.php 公共函數文件
│ └─provider.php 應用容器綁定定義
│ └─tags.php 應用行為擴展定義文件

├─config 應用配置目錄
│ ├─api 模塊配置目錄
│ │ ├─app.php 應用配置
│ │
│ ├─api.php 接口配置
│ ├─app.php 應用配置
│ ├─cache.php 緩存配置
│ ├─cookie.php Cookie配置
│ ├─database.php 數據庫配置
│ ├─log.php 日誌配置
│ ├─session.php Session配置
│ ├─template.php 模板引擎配置
│ └─trace.php Trace配置

├─route 路由定義目錄
│ ├─route.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 命令行入口文件

安裝教程

  1. 克隆本項目代碼
git clone [email protected]:china_wangyu/TP5.1-Restful-Api.git
  1. 進入項目工程
cd TP5.1-Restful-Api
  1. 使用composer更新項目擴展,提升項目安全性、可用性

推薦使用composer中國鏡像源,具體操作見【文檔】

composer update


分享到:


相關文章: