php-crud-api
單一檔案 PHP 腳本,為 SQL 資料庫新增 REST API
php-crud-api 是什麼?
單一檔案 PHP 腳本,為 SQL 資料庫新增 REST API
php-crud-api 概覽
這是什麼
PHP-CRUD-API 是一個單一檔案 PHP 腳本,可為 MySQL/MariaDB、PostgreSQL、SQL Server 或 SQLite 資料庫新增 REST API。它是 PHP 實作的 TreeQL 參考實作。
主要功能
- 可透過 Composer 安裝或使用單一 PHP 檔案,部署簡單
- 支援 POST 變數作為輸入(x-www-form-urlencoded)
- 支援 JSON 物件或 JSON 陣列作為輸入(批次插入)
- 使用型別規則和回呼函式清理與驗證輸入
- 資料庫、資料表、欄位與記錄的權限系統
- 支援多租戶單一與多重資料庫佈局
- 跨網域 CORS 支援
- 支援從多個資料表讀取聯結結果
- 多條件搜尋支援
- 分頁、排序、前 N 筆清單與欄位選擇
- 關聯偵測與巢狀結果(belongsTo、hasMany 和 HABTM)
- 透過 PATCH 支援原子增量(用於計數器)
- 二進位欄位支援 base64 編碼
- 空間/GIS 欄位與篩選支援 WKT 和 GeoJSON
- 對應資料表與欄位名稱以支援舊系統
- 使用 OpenAPI 工具產生 API 文件
- 透過 API 金鑰、JWT 權杖或使用者名稱/密碼進行驗證
- 資料庫連線參數可依驗證結果而定
- 支援以 JSON 格式讀取資料庫結構
- 支援透過 REST 端點修改資料庫結構
- 包含安全性增強中介軟體
- 符合標準:PSR-4、PSR-7、PSR-12、PSR-15 和 PSR-17
使用情境
PHP-CRUD-API 可用於快速為任何現有 SQL 資料庫建立 REST API,無需編寫任何程式碼。它適合為網頁和行動應用程式建立後端服務、原型開發,以及與前端框架(如透過 ra-data-treeql 資料提供者的 React Admin)整合。它也支援多租戶資料庫佈局,並可作為驗證函式庫的儲存層。
快速開始
從最新版本下載 api.php 檔案並上傳至您的網頁伺服器。若要在本機開發,請執行 PHP 內建的網頁伺服器:php -S localhost:8080透過開啟以下網址測試腳本:http://localhost:8080/api.php/records/posts/1別忘了修改檔案底部的設定。
授權與價格
此專案為開放原始碼,採用 MIT 授權。未提供價格資訊。
內容整理自該專案公開的 README 與儲存庫資訊。