前言

PhalApi是一個(gè)PHP輕量級(jí)開源接口框架，助你創(chuàng)造價(jià)值！我們不斷更新，保持生氣；為接口負(fù)責(zé)，為開源負(fù)責(zé)！并承諾永久免費(fèi)！

PhalApi官網(wǎng)請(qǐng)見：www.phalapi.net。

什么是PhalApi 2.x？

PhalApi，簡稱π框架，是一個(gè)PHP輕量級(jí)開源接口框架，專注于接口開發(fā)，致力讓接口開發(fā)更簡單。它：

• 致力于快速、穩(wěn)定、持續(xù)交付有價(jià)值的接口服務(wù)
• 關(guān)注于測(cè)試驅(qū)動(dòng)開發(fā)、領(lǐng)域驅(qū)動(dòng)設(shè)計(jì)、極限編程、敏捷開發(fā)
• 有眾多的擴(kuò)展類庫，與更多開源項(xiàng)目一起提供高效便捷的解決方案
• 支持HTTP、SOAP和RPC協(xié)議，可用于快速搭建微服務(wù)、RESTful接口或Web Services

PhalApi現(xiàn)存有兩大系列版本。分別是經(jīng)典的第一代版本，即1.x系列版本，主要是使用了較為古老傳統(tǒng)的做法；以及全新的第二代版本，即2.x系列版本，主要區(qū)別是：

• 使用了composer統(tǒng)一管理依賴包
• 引入了命名空間
• 遵循PSR-4規(guī)范

溫馨提示：在本開發(fā)文檔中，若未特別標(biāo)明，PhalApi指PhalApi 1.x 版本和PhalApi 2.x 版本。

PhalApi有哪些特點(diǎn)？

PhalApi是一個(gè)很酷的開源框架，對(duì)它越了解，越能發(fā)現(xiàn)它的炫酷所在。以下是部分關(guān)鍵的特性。

特點(diǎn)1：學(xué)習(xí)成本低

PhalApi始終堅(jiān)持KISS原則，并遵循Unix哲學(xué)中的最小立異原則。除了遵循國際慣例，采用約定俗成的做法，PhalApi還在設(shè)計(jì)時(shí)優(yōu)先考慮大家所熟悉的方案。例如，接口返回結(jié)果格式便是路人皆知的JSON格式。對(duì)于剛接觸PHP編程語言的初級(jí)開發(fā)同學(xué)，甚至是之前未曾接觸過PHP的客戶端開發(fā)同學(xué)，根據(jù)以往的學(xué)習(xí)經(jīng)驗(yàn)，大部分情況下，可以在一周內(nèi)完成PhalApi框架的基礎(chǔ)學(xué)習(xí)，并投入到實(shí)際項(xiàng)目開發(fā)中。

特點(diǎn)2：自動(dòng)生成的在線接口文檔

按框架指定的格式完成接口代碼編寫后，PhalApi會(huì)自動(dòng)生成在線接口列表文檔和在線接口詳情文檔，以方便客戶端實(shí)時(shí)查看最新的接口簽名和返回字段。

自動(dòng)生成的在線文檔主要有兩類：

• 在線接口列表文檔
  

• 在線接口詳情文檔
  

特點(diǎn)3：眾多可重用的擴(kuò)展類庫

PhalApi框架擴(kuò)展類庫，是各自獨(dú)立，可重用的組件或類庫，可以直接集成到PhalApi開發(fā)項(xiàng)目，從而讓項(xiàng)目開發(fā)人員感受搭建積木般的編程樂趣，降低開發(fā)成本。

目前，已經(jīng)提供的擴(kuò)展類庫有40+個(gè)，包括:微信公眾號(hào)開發(fā)擴(kuò)展、微信小程序開發(fā)擴(kuò)展、支付擴(kuò)展、上傳擴(kuò)展、Excel表格和Word文檔擴(kuò)展等。

溫馨提示：部分?jǐn)U展類庫需要調(diào)整移植到PhalApi 2.x風(fēng)格方能使用。

特點(diǎn)4：活躍的開源社區(qū)

PhalApi不是“我們”的框架，而是我們大家每個(gè)人的開源框架。PhalApi開源社區(qū)非常活躍，除了有1000+人的實(shí)時(shí)交流群，還有自主搭建的問答社區(qū)，以及近百名參與貢獻(xiàn)的同學(xué)。

PhalApi 2.x的學(xué)習(xí)資料目前還在陸續(xù)補(bǔ)充中，但依然可以參考PhalApi 1.x 版本系列豐富的學(xué)習(xí)資料，有：開發(fā)文檔、視頻教程、《初識(shí)PhalApi》免費(fèi)電子書、博客教程等。

適用場(chǎng)景與范圍

PhalApi代碼開源、產(chǎn)品開源、思想開源，請(qǐng)放心使用。

PhalApi適用的場(chǎng)景，包括但不限于：

• 為移動(dòng)App（包括iOS、iPad、Android、Windowns Phone等終端）提供接口服務(wù)
• 用于搭建接口平臺(tái)系統(tǒng)，提供聚合類接口服務(wù)，供其他后端系統(tǒng)接入使用
• 為前后端分離的H5混合頁面應(yīng)用，提供Ajax異步接口

對(duì)于架構(gòu)無關(guān)、專注架構(gòu)及提升架構(gòu)這三種情況，PhalApi都能勝任之。

正如其他負(fù)責(zé)任的開源框架一樣，PhlaApi也有其不適宜使用的時(shí)機(jī)。包括但不限于：

• 開發(fā)CLI項(xiàng)目（但已提供支持命令行項(xiàng)目開發(fā)的CLI擴(kuò)展類庫）
• 開發(fā)網(wǎng)站項(xiàng)目，即有界面展示和視圖渲染（但已提供支持視圖渲染的View擴(kuò)展類庫）
• 對(duì)數(shù)據(jù)嚴(yán)謹(jǐn)性要求高，如金融行業(yè)的相關(guān)項(xiàng)目，畢竟PHP是弱類型語言

文檔目標(biāo)讀者

本開發(fā)文檔的目標(biāo)讀者是：

• 初次接觸PhalApi框架的開發(fā)同學(xué)
• 正在使用PhalApi進(jìn)行項(xiàng)目開發(fā)的同學(xué)
• 任何想了解或?qū)W習(xí)PhalApi框架的同學(xué)

聯(lián)系我們

關(guān)于本開發(fā)文檔，任何問題，都可反饋到 這里，謝謝！