1樓:
就目前來說Restful方式的介面位址設計,統一響應格式的介面返回就是良好的介面文件規範。
介面文件的管理推薦 docway文件管理工具,支援markdown語法,mock,http介面測試,多團隊多角色多許可權,歷史記錄等等功能。
docWay 介面文件管理
功能說明 - 演示專案
2樓:管博
- 在Github上開乙個專案。
- README作為互動協議的目錄,每個介面都是乙個.md。(Markdown是好東西)
- 前後端自治,用Pull Request貢獻,爭議部分用Issue蓋樓。
- 根目錄下有test目錄,裡面對應每個.md有對應的-test.js
- 根目錄下的`Package.json`應有mocha之類的依賴,`bdd`、`tdd`都行。
- Restfull教你怎麼少發明輪子,但沒有什麼是絕對的。例如:檔案上傳沒必須這樣。
- 如果你用[loopback](http://
loopback.io/
),記得開啟http://
0.0.0.0:3000/explorer
。也許你50%的協議可以不用寫了。
3樓:春哥
對外的東西一定要慎重。像這種介面建議相關的人員坐在一起,仔細考慮下。
在介面的設計上有一些常見的技巧可以參考下:
1. 介面增加版本號字段。這樣可以方便server端根據版本號做相應的相容判斷。
2. 增加相應的訪問授權字段,避免非授權的訪問。
3. 增加相應的校驗字段,以保證資料傳輸是完整的。
4. 如果有可能,啟用壓縮。
5. 用json,不要用xml。
6. 介面要形成文件,定期更新維護。
7. 介面最好有統一的呼叫入口,方便做集中的控制。
4樓:kevin yuan
首先,介面文件不應以前端作為主導方提出,而是由服務端進行介面文件的編寫工作,在編寫完成後,和前端一起協商補充,這樣做是最好的。前端只負責資料的展示,所以沒必要由前端進行介面定義,因為服務端的邏輯處理如果完全按照前端提出的來,那還咋設計。。最重要的是溝通,並且熟悉業務邏輯。
預算一定的情況下,如何選擇衛浴產品?
Roca樂家衛浴 考慮品牌 優選專業的衛浴品牌,功能設計成熟,產品工藝和品質有保障。Roca樂家百年來始終專注衛浴產品的設計 研發 生產及衛浴空間的整體設計方案,只為打造更貼心更高階的衛浴使用體驗。考慮服務 完善的售前和售後有保障。考慮使用需求和產品功能的高度匹配 此外還能公升級使用者沒有Get到的...
這個世界上誰定的善惡是非?
Uno Whoiam 善惡的內涵 而不是 善 惡 這兩個 名字 不是誰定的,他們本來就是存在的,是自然規律。而古往今來一些先知先覺者,領悟了這些規律後,將它們定義為 善 惡 罷了 道可道非常道,名可名,非常名。孔子述而不作,釋迦摩尼涅槃稱己無言。聖賢們從來就沒有定義過什麼,只是大自然借助他們之言行舉...
高中該怎麼定自己的大學專業?
xu龍兒 一定要好好填,不能隨便,來自大三狗的經驗。總之,資訊收集是最主要的,首先你要明白自己以後想幹什麼樣的工作,然後在選專業,雖然以後出來工作有很多和所學專業不一樣,但是從一開始就弄清楚自己喜歡什麼然後朝著奮鬥不好嗎?而且更有效,要知道學乙份你覺得對你未來工作用處不大的專業是很痛苦的!還有就是你...