java nei_NEI 接口管理平台
原標題:NEI 接口管理平臺
對于現代 Web 產品來說,API 的重要性不言而喻,相信前后端工程師都深有體會。
關于 API 的開發流程,筆者咨詢過一些朋友,也在面試的過程中問過一些候選人,抱隨意的態度較多:口頭約定、郵件約定、通過即時聊天工具發送,也有編寫較詳細的 Word 文檔的。大家都被這么一個問題困繞著:想了解 API 的完整參數及含義,除了看源碼之外別無他法。如果是自己編寫的代碼,短期內還能回想起來,如果是別人編寫的代碼,那可能看了源碼也還是一知半解。
再說一個在開發中的常見現象。API 中的 ID 字段,對類型“不敏感”的后端工程師,可能一會兒返回 number 類型,一會兒返回 string 類型。而前端工程師,都喜歡用“===”來判斷,對類型有嚴格的要求。對于 number 類型,如果超過一定的位數,在瀏覽器端又會有溢出的問題。就這么一個類型不一致的問題,不知道浪費了全世界工程師的多少青春歲月。
所以,我們迫切需要這么一個產品:
方便地管理項目中的所有 API
API 文檔清晰直觀并且方便查看
有自動化 API 測試工具,方便開發和測試工程師進行回歸測試
有方便地生成規范的 API 的功能,比如 RESTful API
對于前端工程師來說,還有一個必不可少的功能:API 模擬容器(響應數據是根據 API 定義 MOCK 出來的),以便在后端沒有開發好接口之前就能進行頁面開發。這個 API 模擬容器對代碼沒有侵入性,即前端編寫的代碼,上線時不需要進行任何處理。
就筆者的觀察,能滿足以上需求的工具在整個業界(包括國外)都還很少見。
今天向大家推薦一款 API 管理產品:NEI 接口管理平臺(訪問地址 https://nei.netease.com, 以下簡稱 NEI)。
NEI 是網易杭研前端技術部推出的一款產品,旨在幫助項目團隊更好的管理 API 接口。NEI 是杭研前端團隊多年的技術沉淀,是很多位資深工程師的豐富經驗總結,之前一直只有網易內部用戶才能使用,今年 9 月初正式對外部用戶開放。
下面大致地介紹一下 NEI。
NEI 按項目來管理所有資源,資源的創建和維護可由團隊成員協作完成,目前它已經提供了以下功能:
項目管理:動態、團隊管理、權限管理、項目文檔等
頁面管理:項目中的頁面定義
異步接口:即本文所說的 API,可以定義請求頭、請求數據、發送規則、響應頭、響應結果、接收規則等
接口測試和用例管理:方便回歸測試和生成測試代碼
數據模型:NEI 中最強大的功能之一,對應數據庫中的實體對象
頁面模板:NEI 配套的構建工具會根據定義生成模板文件
規則函數:自定義 MOCK 數據,NEI 也預置了常見的規則函數
業務分組:按照業務對項目資源進行細分,方便管理
工程規范:本身可以當作腳手架,也可以和 NEI 項目結合,集成項目中的 API 和數據模型
消息中心:保證重要的操作能及時通知到相關負責人
下面是幾篇介紹文章:
NEI 基本概念介紹
使用 NEI 進行前后端并行開發
老項目遷移到 NEI 上的說明
NEI 工程規范介紹
一步一步教你如何愉快地生成 JavaBean 文件
以上所有文章都放在 Github 倉庫的 doc 目錄下:NEI 配套構建工具。
如果 NEI 能解決您遇到的一些麻煩事兒,那就趕緊去試試吧。
最后,也歡迎大家在使用的過程中給我們提建議和意見:
需求提議地址:Issues · NEYouFan/nei-toolkit · GitHub
NEI QQ 交流群號:453281988
目前 NEI 已經托管在網易云上,在此也非常感謝網易云提供的服務。
最后,文中有涉及到的鏈接可通過“閱讀原文”查看
關于本文
作者:包勇明
鏈接:https://zhuanlan.zhihu.com/p/23191873
每天早讀,三萬同行相伴成長
歡迎投稿:181422448@qq.com返回搜狐,查看更多
責任編輯:
總結
以上是生活随笔為你收集整理的java nei_NEI 接口管理平台的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 从银行卡上面能看出是一类卡吗
- 下一篇: java 并发编程 aqs_Java并发