1. 從零理解 Web API 的創(chuàng)建、發(fā)布與測(cè)試很多人第一次接觸 Web API 這個(gè)概念時(shí)腦子里浮現(xiàn)的是一堆問(wèn)號(hào)它跟普通的網(wǎng)頁(yè)有什么區(qū)別為什么后端同事總把“接口”掛在嘴邊我能不能自己搞一個(gè)出來(lái)玩玩如果你正好處于這個(gè)階段那這篇內(nèi)容就是寫(xiě)給你的。我自己帶過(guò)不少剛?cè)胄械呐笥寻l(fā)現(xiàn)大家卡住的地方往往不是代碼本身而是對(duì)整個(gè)流程沒(méi)有全局感——不知道一個(gè) API 從無(wú)到有要經(jīng)歷哪幾步每一步又在解決什么問(wèn)題。所以這里我打算把“創(chuàng)建、發(fā)布、測(cè)試”這條鏈路完整走一遍用最樸素的工具和最直白的語(yǔ)言讓你看完就能自己動(dòng)手復(fù)現(xiàn)一個(gè)可用的 Web API。先把這個(gè)詞拆開(kāi)看。Web API 本質(zhì)上就是一段部署在網(wǎng)絡(luò)上的程序它對(duì)外暴露一個(gè)地址別人用特定的方式訪問(wèn)這個(gè)地址它返回一段結(jié)構(gòu)化的數(shù)據(jù)。跟普通網(wǎng)頁(yè)最大的區(qū)別在于網(wǎng)頁(yè)返回的是給人看的 HTML 頁(yè)面而 API 返回的是給程序讀的數(shù)據(jù)通常是 JSON 格式。你手機(jī)上的 App 能顯示天氣、能刷出訂單列表背后都是它在跟服務(wù)器上的 API 打交道。理解了這一點(diǎn)你就明白為什么它值得單獨(dú)拿出來(lái)練——它是現(xiàn)代軟件之間溝通的標(biāo)準(zhǔn)方式。這篇內(nèi)容適合三類(lèi)人一是剛學(xué)完后端基礎(chǔ)語(yǔ)法、想找個(gè)完整小項(xiàng)目練手的新手二是做前端或客戶端開(kāi)發(fā)、想搞清楚接口到底怎么來(lái)的同學(xué)三是需要自己搭個(gè)臨時(shí)服務(wù)做數(shù)據(jù)模擬的測(cè)試人員。我會(huì)從最基礎(chǔ)的環(huán)境準(zhǔn)備講起然后一步步創(chuàng)建接口、把它跑起來(lái)、再用手邊的工具去驗(yàn)證它是否正常工作。整個(gè)過(guò)程不需要復(fù)雜的服務(wù)器知識(shí)一臺(tái)普通電腦就夠。關(guān)鍵詞里提到的“入門(mén)練習(xí)”四個(gè)字很關(guān)鍵我的目標(biāo)不是教你搭建企業(yè)級(jí)架構(gòu)而是讓你用最短的路徑跑通全流程建立信心之后再往深處走。2. 動(dòng)手前的整體設(shè)計(jì)與思路拆解2.1 為什么選擇從最小可運(yùn)行單元開(kāi)始新手最容易犯的錯(cuò)誤是一上來(lái)就想做個(gè)“完整系統(tǒng)”結(jié)果環(huán)境配置就耗掉三天熱情直接磨沒(méi)了。我的建議是先做一個(gè)只包含單個(gè)接口的最小服務(wù)能返回一句“hello”就行。這個(gè)思路背后的邏輯是創(chuàng)建、發(fā)布、測(cè)試這三個(gè)環(huán)節(jié)各自都有獨(dú)立的坑如果同時(shí)引入數(shù)據(jù)庫(kù)、用戶認(rèn)證、復(fù)雜路由你根本分不清報(bào)錯(cuò)來(lái)自哪一層。把變量控制到最少才能快速定位問(wèn)題。具體來(lái)說(shuō)我選用的技術(shù)組合是 Node.js 加 Express 框架。原因有三點(diǎn)第一JavaScript 語(yǔ)法對(duì)新手友好不需要額外學(xué)一門(mén)語(yǔ)言第二Express 是目前最輕量的 Web 框架之一幾行代碼就能起一個(gè)服務(wù)沒(méi)有黑盒魔法第三npm 生態(tài)里有大量現(xiàn)成的測(cè)試工具后面驗(yàn)證接口時(shí)非常方便。當(dāng)然如果你更熟悉 Python用 Flask 也是完全一樣的思路本文的方法論可以平移過(guò)去。2.2 創(chuàng)建、發(fā)布、測(cè)試三者的關(guān)系很多人把這三個(gè)詞當(dāng)成三個(gè)獨(dú)立階段其實(shí)它們是環(huán)環(huán)相扣的。創(chuàng)建是寫(xiě)代碼定義接口的行為發(fā)布是讓這段代碼在某個(gè)地址上持續(xù)運(yùn)行、等待別人訪問(wèn)測(cè)試則是模擬真實(shí)調(diào)用去驗(yàn)證行為是否符合預(yù)期。我見(jiàn)過(guò)有人代碼寫(xiě)完了卻不知道怎么讓別人訪問(wèn)也見(jiàn)過(guò)接口明明能跑但一測(cè)就發(fā)現(xiàn)返回格式不對(duì)。所以我在設(shè)計(jì)練習(xí)時(shí)刻意讓每個(gè)環(huán)節(jié)都有明確的產(chǎn)出物創(chuàng)建階段的產(chǎn)出是一個(gè)能本地運(yùn)行的文件發(fā)布階段的產(chǎn)出是一個(gè)局域網(wǎng)內(nèi)可訪問(wèn)的地址測(cè)試階段的產(chǎn)出是一份包含正常和異常情況的驗(yàn)證記錄。這里有個(gè)容易被忽略的點(diǎn)發(fā)布不等于部署到公網(wǎng)。對(duì)于入門(mén)練習(xí)來(lái)說(shuō)把服務(wù)跑在自己電腦上、讓同一個(gè)局域網(wǎng)內(nèi)的手機(jī)或另一臺(tái)電腦能訪問(wèn)就已經(jīng)完成了“發(fā)布”的核心目標(biāo)——讓服務(wù)持續(xù)監(jiān)聽(tīng)某個(gè)端口并響應(yīng)請(qǐng)求。公網(wǎng)部署涉及的東西太多不適合作為第一課。等你把本地這套玩熟了再去了解服務(wù)器和域名也不遲。2.3 工具選型背后的考量工欲善其事必先利其器。我在練習(xí)中會(huì)用到幾個(gè)工具這里先說(shuō)明為什么選它們。代碼編輯器用 VS Code免費(fèi)且插件豐富調(diào)試 Node.js 很方便。接口測(cè)試工具用 Postman 或者 curl 命令前者有圖形界面適合新手后者幾乎任何系統(tǒng)都自帶、適合理解底層。查看端口占用情況用系統(tǒng)自帶的命令行工具Windows 上是 netstatmacOS 和 Linux 上是 lsof。提示不要在這個(gè)階段糾結(jié)工具是否“最專(zhuān)業(yè)”。我見(jiàn)過(guò)有人為了選一個(gè)“完美”的測(cè)試工具對(duì)比了一整天結(jié)果一行代碼沒(méi)寫(xiě)。先用起來(lái)用著不順手再換成本很低。3. 核心細(xì)節(jié)解析與實(shí)操要點(diǎn)3.1 環(huán)境搭建的關(guān)鍵步驟與驗(yàn)證方法第一步是安裝 Node.js。去官網(wǎng)下載 LTS 版本即可安裝完成后打開(kāi)命令行輸入node -v和npm -v如果都能輸出版本號(hào)說(shuō)明安裝成功。這里有個(gè)細(xì)節(jié)Windows 用戶安裝時(shí)建議勾選“Add to PATH”否則命令行找不到 node 命令。macOS 用戶如果用 Homebrew直接brew install node更省事。第二步是初始化項(xiàng)目。新建一個(gè)文件夾進(jìn)入后執(zhí)行npm init -y它會(huì)生成一個(gè) package.json 文件記錄項(xiàng)目的基本信息和依賴。這個(gè)文件很重要后面安裝的每個(gè)庫(kù)都會(huì)登記在里面相當(dāng)于項(xiàng)目的身份證。然后執(zhí)行npm install express安裝 Express 框架。安裝完成后你會(huì)看到多了一個(gè) node_modules 文件夾里面是依賴的源碼不需要手動(dòng)改。第三步是驗(yàn)證環(huán)境。創(chuàng)建一個(gè) app.js 文件寫(xiě)入最簡(jiǎn)單的服務(wù)代碼然后運(yùn)行node app.js。如果命令行沒(méi)有報(bào)錯(cuò)并且提示服務(wù)已啟動(dòng)在某個(gè)端口就說(shuō)明環(huán)境沒(méi)問(wèn)題。我建議在這個(gè)階段多試幾次啟動(dòng)和停止熟悉一下命令行的反饋因?yàn)楹竺嬲{(diào)試時(shí)會(huì)頻繁用到。3.2 接口定義中的路由與請(qǐng)求方法路由是 API 的核心概念它決定了“訪問(wèn)哪個(gè)地址、用什么方式訪問(wèn)、執(zhí)行什么邏輯”。舉個(gè)例子GET /users表示用 GET 方式訪問(wèn) /users 這個(gè)路徑通常用來(lái)獲取用戶列表POST /users表示用 POST 方式訪問(wèn)同一路徑通常用來(lái)創(chuàng)建新用戶。路徑相同但方法不同代表不同的操作這是 RESTful 風(fēng)格的基本約定。在 Express 里定義路由非常直觀app.get(/users, (req, res) { ... })。第一個(gè)參數(shù)是路徑第二個(gè)參數(shù)是處理函數(shù)函數(shù)里的 req 代表請(qǐng)求對(duì)象包含客戶端傳來(lái)的數(shù)據(jù)res 代表響應(yīng)對(duì)象用來(lái)返回?cái)?shù)據(jù)。新手常犯的錯(cuò)誤是忘記調(diào)用 res 的發(fā)送方法導(dǎo)致請(qǐng)求一直掛起、瀏覽器轉(zhuǎn)圈。記住每個(gè)處理函數(shù)必須有且只有一次響應(yīng)結(jié)束操作。請(qǐng)求方法的選擇也有講究。GET 用于讀取數(shù)據(jù)參數(shù)通常放在 URL 里POST 用于提交數(shù)據(jù)參數(shù)放在請(qǐng)求體里PUT 和 PATCH 用于更新DELETE 用于刪除。入門(mén)練習(xí)先把 GET 和 POST 這兩個(gè)最常用的搞明白其他方法等有需要再查文檔。3.3 請(qǐng)求參數(shù)與響應(yīng)格式的處理客戶端傳數(shù)據(jù)給服務(wù)端有三種常見(jiàn)方式URL 查詢參數(shù)如 /search?keywordabc、路徑參數(shù)如 /users/123 中的 123、請(qǐng)求體POST 時(shí)攜帶的 JSON 數(shù)據(jù)。Express 里分別用req.query、req.params、req.body來(lái)獲取。注意req.body需要額外配置中間件才能解析早期版本要裝 body-parser現(xiàn)在 Express 內(nèi)置了express.json()加一行app.use(express.json())即可。響應(yīng)格式我強(qiáng)烈建議統(tǒng)一成 JSON。一個(gè)規(guī)范的響應(yīng)至少包含兩部分狀態(tài)碼和數(shù)據(jù)結(jié)構(gòu)。狀態(tài)碼用 HTTP 自帶的200 表示成功400 表示客戶端傳參有問(wèn)題404 表示路徑不存在500 表示服務(wù)端內(nèi)部錯(cuò)誤。數(shù)據(jù)結(jié)構(gòu)里可以放code、message、data三個(gè)字段code 是業(yè)務(wù)狀態(tài)碼message 是給人看的提示data 是實(shí)際數(shù)據(jù)。這樣前端拿到響應(yīng)后能統(tǒng)一處理不用為每個(gè)接口寫(xiě)不同的解析邏輯。注意不要把所有錯(cuò)誤都返回 200 然后靠 body 里的 code 區(qū)分。HTTP 狀態(tài)碼是給網(wǎng)絡(luò)層和工具看的用對(duì)了能讓調(diào)試效率翻倍。比如 Postman 會(huì)自動(dòng)根據(jù)狀態(tài)碼標(biāo)紅失敗請(qǐng)求你一眼就能發(fā)現(xiàn)問(wèn)題。4. 實(shí)操過(guò)程與核心環(huán)節(jié)實(shí)現(xiàn)4.1 創(chuàng)建第一個(gè)可運(yùn)行的 API 服務(wù)打開(kāi) VS Code新建文件夾my-first-api在里面創(chuàng)建app.js。先寫(xiě)引入和初始化const express require(express); const app express(); const PORT 3000; app.use(express.json());這三行代碼做了三件事引入 Express、創(chuàng)建應(yīng)用實(shí)例、定義端口號(hào)。app.use(express.json())是中間件讓服務(wù)能解析 JSON 格式的請(qǐng)求體。中間件的概念可以理解為“請(qǐng)求進(jìn)入處理函數(shù)之前經(jīng)過(guò)的關(guān)卡”后面還可以加日志、鑒權(quán)等關(guān)卡。接著定義一個(gè)最簡(jiǎn)單的接口app.get(/hello, (req, res) { res.json({ code: 0, message: success, data: { text: Hello, Web API! } }); });這段代碼的意思是當(dāng)有人用 GET 方式訪問(wèn) /hello 時(shí)返回一個(gè) JSON 對(duì)象。res.json()會(huì)自動(dòng)設(shè)置響應(yīng)頭為 JSON 類(lèi)型并把對(duì)象序列化成字符串。最后啟動(dòng)服務(wù)app.listen(PORT, () { console.log(Server is running on http://localhost:${PORT}); });保存后在命令行執(zhí)行node app.js看到提示信息就說(shuō)明服務(wù)起來(lái)了。打開(kāi)瀏覽器訪問(wèn)http://localhost:3000/hello應(yīng)該能看到返回的 JSON 數(shù)據(jù)。恭喜你的第一個(gè) API 已經(jīng)創(chuàng)建成功。4.2 增加帶參數(shù)的接口并處理異常光有一個(gè)靜態(tài)接口不夠真實(shí)場(chǎng)景里接口需要接收參數(shù)。我們來(lái)加一個(gè)根據(jù)用戶 ID 返回信息的接口app.get(/users/:id, (req, res) { const userId req.params.id; if (!/^\d$/.test(userId)) { return res.status(400).json({ code: 400, message: 用戶 ID 必須是數(shù)字, data: null }); } res.json({ code: 0, message: success, data: { id: userId, name: 用戶${userId} } }); });這里用到了路徑參數(shù):idExpress 會(huì)自動(dòng)把匹配到的值放進(jìn)req.params。我加了一個(gè)正則校驗(yàn)如果 ID 不是純數(shù)字就返回 400 錯(cuò)誤。這個(gè)校驗(yàn)看起來(lái)簡(jiǎn)單但它是接口健壯性的基礎(chǔ)——永遠(yuǎn)不要相信客戶端傳來(lái)的數(shù)據(jù)。你可以試試訪問(wèn)/users/abc會(huì)看到錯(cuò)誤提示訪問(wèn)/users/123會(huì)看到正常數(shù)據(jù)。再加一個(gè) POST 接口接收請(qǐng)求體app.post(/users, (req, res) { const { name, age } req.body; if (!name || typeof age ! number) { return res.status(400).json({ code: 400, message: name 必填age 必須是數(shù)字, data: null }); } res.status(201).json({ code: 0, message: 創(chuàng)建成功, data: { name, age } }); });注意這里用了 201 狀態(tài)碼表示資源創(chuàng)建成功。參數(shù)校驗(yàn)邏輯雖然簡(jiǎn)單但覆蓋了必填和類(lèi)型檢查兩個(gè)最常見(jiàn)的場(chǎng)景。實(shí)際項(xiàng)目中校驗(yàn)會(huì)更復(fù)雜但思路是一樣的先檢查不通過(guò)就返回錯(cuò)誤通過(guò)才繼續(xù)處理。4.3 讓服務(wù)在局域網(wǎng)內(nèi)可訪問(wèn)默認(rèn)情況下服務(wù)只監(jiān)聽(tīng) localhost也就是只有本機(jī)能訪問(wèn)。如果你想讓同一 WiFi 下的手機(jī)訪問(wèn)需要做兩件事。第一把監(jiān)聽(tīng)地址改成0.0.0.0app.listen(PORT, 0.0.0.0, () { console.log(Server is running on port ${PORT}); });第二找到本機(jī)的局域網(wǎng) IP。Windows 上用ipconfigmacOS 和 Linux 上用ifconfig或ip addr找到類(lèi)似 192.168.x.x 的地址。然后在手機(jī)瀏覽器里訪問(wèn)http://192.168.x.x:3000/hello如果能看到數(shù)據(jù)說(shuō)明發(fā)布成功。這里有個(gè)常見(jiàn)的坑防火墻可能會(huì)攔截外部訪問(wèn)。如果手機(jī)訪問(wèn)不了先檢查系統(tǒng)防火墻設(shè)置把 Node.js 或?qū)?yīng)端口加入允許列表。另外公司或?qū)W校的網(wǎng)絡(luò)可能做了隔離設(shè)備之間無(wú)法互相訪問(wèn)這種情況換一個(gè)網(wǎng)絡(luò)環(huán)境再試。提示局域網(wǎng)訪問(wèn)只是練習(xí)手段不要把它當(dāng)成正式部署。正式部署需要考慮進(jìn)程守護(hù)、日志收集、錯(cuò)誤監(jiān)控等一系列問(wèn)題那是另一個(gè)階段的事。4.4 用工具驗(yàn)證接口的正確性服務(wù)跑起來(lái)后需要系統(tǒng)地測(cè)試。我習(xí)慣先用 curl 快速驗(yàn)證再用 Postman 做完整測(cè)試。curl 的基本用法是curl http://localhost:3000/hello curl http://localhost:3000/users/123 curl -X POST http://localhost:3000/users -H Content-Type: application/json -d {name:張三,age:25}第一條測(cè)試 GET 接口第二條測(cè)試路徑參數(shù)第三條測(cè)試 POST 接口。-X指定請(qǐng)求方法-H設(shè)置請(qǐng)求頭-d攜帶請(qǐng)求體。如果返回的 JSON 符合預(yù)期說(shuō)明接口工作正常。Postman 的優(yōu)勢(shì)在于可以保存請(qǐng)求、組織成集合、批量運(yùn)行。我建議把每個(gè)接口的正常和異常情況都存成獨(dú)立的請(qǐng)求比如/users/123存一個(gè)正常的/users/abc存一個(gè)異常的。這樣每次改完代碼點(diǎn)一下“Run Collection”就能全部回歸一遍比手動(dòng)敲命令高效得多。測(cè)試時(shí)重點(diǎn)關(guān)注四個(gè)方面狀態(tài)碼是否正確、返回結(jié)構(gòu)是否統(tǒng)一、參數(shù)校驗(yàn)是否生效、異常情況是否有友好提示。我見(jiàn)過(guò)不少新手只測(cè)正常流程結(jié)果上線后遇到空參數(shù)直接崩潰。把異常測(cè)試當(dāng)成習(xí)慣能省掉大量排查時(shí)間。5. 常見(jiàn)問(wèn)題與排查技巧實(shí)錄5.1 啟動(dòng)報(bào)錯(cuò)與端口占用處理最常見(jiàn)的報(bào)錯(cuò)是Error: listen EADDRINUSE: address already in use意思是端口被占用了。原因通常是上一個(gè)服務(wù)沒(méi)關(guān)掉或者別的程序用了同一個(gè)端口。解決辦法有兩個(gè)一是找到占用端口的進(jìn)程并結(jié)束它Windows 上用netstat -ano | findstr :3000找到 PID再用任務(wù)管理器結(jié)束macOS 和 Linux 上用lsof -i :3000找到 PID再kill -9 PID。二是直接換個(gè)端口比如把 3000 改成 3001。另一個(gè)常見(jiàn)報(bào)錯(cuò)是Cannot find module express說(shuō)明依賴沒(méi)裝好。檢查一下是不是在正確的目錄下執(zhí)行了npm install express以及 node_modules 文件夾是否存在。如果確認(rèn)裝了還報(bào)錯(cuò)刪掉 node_modules 和 package-lock.json重新npm install一次通常能解決。5.2 請(qǐng)求無(wú)響應(yīng)或返回格式錯(cuò)誤請(qǐng)求一直掛起、瀏覽器轉(zhuǎn)圈九成是因?yàn)樘幚砗瘮?shù)里沒(méi)有調(diào)用 res 的發(fā)送方法。檢查每個(gè)路由確保有且只有一次res.json()、res.send()或res.end()。如果調(diào)用了兩次會(huì)報(bào)Cannot set headers after they are sent錯(cuò)誤意思是響應(yīng)已經(jīng)發(fā)出去了還想再發(fā)一次。返回格式錯(cuò)誤通常是因?yàn)橥嗽O(shè)置Content-Type。用res.json()會(huì)自動(dòng)設(shè)置但如果你用res.send()發(fā)送對(duì)象Express 也會(huì)自動(dòng)轉(zhuǎn) JSON。真正容易出問(wèn)題的是手動(dòng)拼接字符串返回這時(shí)候要確保格式合法。我的建議是統(tǒng)一用res.json()省心。5.3 參數(shù)獲取不到的排查思路POST 請(qǐng)求里req.body是 undefined最常見(jiàn)的原因是忘了加app.use(express.json())。這個(gè)中間件必須放在所有路由定義之前否則不生效。另一個(gè)原因是請(qǐng)求頭沒(méi)有設(shè)置Content-Type: application/json服務(wù)端不知道該怎么解析請(qǐng)求體。路徑參數(shù)獲取不到檢查路由定義里的冒號(hào)有沒(méi)有寫(xiě)對(duì)比如/users/:id寫(xiě)成了/users/id那就變成固定路徑了。查詢參數(shù)獲取不到檢查 URL 里有沒(méi)有用?拼接比如/search?keywordabcreq.query.keyword才能拿到值。5.4 常見(jiàn)問(wèn)題速查表問(wèn)題現(xiàn)象可能原因解決方法啟動(dòng)報(bào)端口占用端口被其他進(jìn)程使用換端口或結(jié)束占用進(jìn)程找不到 express 模塊依賴未安裝或目錄不對(duì)在項(xiàng)目目錄重新安裝依賴請(qǐng)求一直掛起處理函數(shù)未發(fā)送響應(yīng)檢查是否調(diào)用 res 發(fā)送方法req.body 為 undefined缺少 JSON 解析中間件添加 app.use(express.json())路徑參數(shù)獲取不到路由定義缺少冒號(hào)檢查路由路徑寫(xiě)法局域網(wǎng)無(wú)法訪問(wèn)監(jiān)聽(tīng)地址或防火墻問(wèn)題改為 0.0.0.0 并檢查防火墻響應(yīng)格式不是 JSON未設(shè)置正確的內(nèi)容類(lèi)型統(tǒng)一使用 res.json()這張表是我自己踩坑后整理的基本上覆蓋了入門(mén)階段 90% 的問(wèn)題。遇到報(bào)錯(cuò)先查表查不到再去看命令行輸出的完整錯(cuò)誤信息通常里面會(huì)直接告訴你哪一行出了問(wèn)題。5.5 幾個(gè)容易被忽略的實(shí)操心得第一個(gè)心得每次改完代碼都要重啟服務(wù)。Node.js 默認(rèn)不會(huì)自動(dòng)重載改了文件必須 CtrlC 停掉再重新node app.js。如果嫌麻煩可以裝 nodemon用nodemon app.js啟動(dòng)它會(huì)監(jiān)聽(tīng)文件變化自動(dòng)重啟。這個(gè)工具能省下大量重復(fù)操作的時(shí)間。第二個(gè)心得日志要打在對(duì)的地方。新手喜歡用console.log到處打結(jié)果控制臺(tái)刷屏找不到重點(diǎn)。我的做法是在每個(gè)路由入口打一條帶路徑和參數(shù)的日志出錯(cuò)時(shí)打一條帶錯(cuò)誤詳情的日志其他中間過(guò)程不打。這樣出問(wèn)題時(shí)能快速定位是哪個(gè)請(qǐng)求、傳了什么參數(shù)、在哪一步失敗。第三個(gè)心得測(cè)試用例要覆蓋邊界情況。比如參數(shù)為空字符串、傳了超長(zhǎng)字符串、傳了特殊字符、傳了錯(cuò)誤類(lèi)型這些情況在真實(shí)環(huán)境里都會(huì)遇到。我習(xí)慣在寫(xiě)接口的同時(shí)就把這些異常用例想好寫(xiě)完立刻測(cè)一遍比事后補(bǔ)測(cè)效率高得多。第四個(gè)心得把接口文檔和代碼放在一起維護(hù)?？梢栽陧?xiàng)目里建一個(gè) README列出每個(gè)接口的路徑、方法、參數(shù)、返回示例。改代碼時(shí)順手更新文檔避免時(shí)間久了連自己都忘了某個(gè)接口是干什么的。這個(gè)習(xí)慣在接口數(shù)量超過(guò)五個(gè)之后會(huì)顯得特別重要。6. 從練習(xí)到實(shí)用的擴(kuò)展方向把基礎(chǔ)流程跑通之后你可以沿著幾個(gè)方向繼續(xù)深入。第一個(gè)方向是數(shù)據(jù)持久化現(xiàn)在接口返回的數(shù)據(jù)都是寫(xiě)死的可以引入 SQLite 或 JSON 文件存儲(chǔ)讓數(shù)據(jù)能真正保存下來(lái)。第二個(gè)方向是接口鑒權(quán)給某些接口加上 token 校驗(yàn)理解身份驗(yàn)證的基本原理。第三個(gè)方向是錯(cuò)誤處理中間件把散落在各個(gè)路由里的錯(cuò)誤處理邏輯抽出來(lái)統(tǒng)一管理讓代碼更整潔。我個(gè)人在實(shí)際操作中的體會(huì)是入門(mén)階段最大的障礙不是技術(shù)難度而是信息過(guò)載。網(wǎng)上關(guān)于 Web API 的教程太多了每個(gè)都講得很全反而讓人不知道從哪下手。我的建議是先把本文這套最小流程完整走一遍跑通之后再去看其他資料你會(huì)發(fā)現(xiàn)大部分內(nèi)容都能對(duì)應(yīng)上理解起來(lái)快得多。最后再分享一個(gè)小技巧把你練習(xí)用的項(xiàng)目傳到代碼托管平臺(tái)每次改動(dòng)都提交一次這樣既能記錄學(xué)習(xí)過(guò)程也能在改崩了之后快速回滾。這個(gè)習(xí)慣從第一天就養(yǎng)成受益無(wú)窮。