iT邦幫忙

1

HeLei RESTful-API所產生的api文件,對前端開發人員來說資訊充足完整嗎?

大家好:我不是技術人員,我家前端和後台溝通出了問題,導致專案無法進行,不知有無可有大大可幫忙釋疑?

我家後台工程師自從用了HeLei RESTful-API的工具後,就以該工具提供api文件,
我們安卓開發前端工程師因為換了人開發,他要求api文件應該要明確的寫清楚input和output規格(前個開發人員其實也曾低調的反應這樣的文件沒他以前工作的team清楚)。
我個人大概用過一兩次這文件的驗證功能,這文件工具"似乎"如前台所說沒能很明確的看出 input output 的產出為何,我於是請後台配合提供,後台示他不太願意,說等於要他重新再做一次,他感到相當為難。

後台的說法是:我就是給HeLei RESTful-API 做的文件,要input output規格請前端自己做,或你有沒有可能找個人給我幫他做input output文件?

前台的說法是:這個RESTful-API做出來的文件,一般會用在開發到一定程度後,用來測試會相當驚艷,但我現在需要的是系統設計文件,後台以RESTful-API製作api文件時,一定會經過思考該資料是怎樣輸入與輸出的階段,弄完後製作後才會是現在看到的樣子(i/o過程細節交代不夠清楚),需要明確定義所有功能input和output才有辦法開發。

專案現在卡住動不了,請問一般會建議怎樣處理這樣的狀況較好呢?
因我非專業技術人員,且對HeLei RESTful-API不是很懂,以上的說明用語可能不是很適切,希望技術大大們看懂我的問題。如仍不太清楚,還請告知要補充哪些說明,我會盡量補充。

感謝大大們撥冗看完我的問題,希望有機會排除這困擾。謝謝大家。

2 個回答

2
海綿寶寶
iT邦大神 1 級 ‧ 2017-05-31 09:24:23
最佳解答

每個問題都有「技術」和「非技術」兩個方向可以思考
你這個問題我個人覺得比較偏向「非技術」層面
簡單說
是「人」的問題,不是「工具」的問題

既然後台已經寫好了API文件
那就表示專案已經過了「系統分析」的階段
那麼API文件是適合與否
就交給負責這個專案「系統分析」的人去決定就好了

另外
我Google不到 HeLei RESTful-API 的資料
你可不可以貼一小部份API文件長得什麼樣子
給大家看看呢?

謝謝

另外

前台的說法是:這個RESTful-API做出來的文件,一般會用在開發到一定程度後,用來測試會相當驚艷

如果這文件可以用來自動化測試的話
那我就先投「這API是足夠的」一票
前台真正需要的恐怕不是API的規格
而是App的規格

另外
如果你那個HeLei的文件
長得類似Swagger的話
那我就舉雙手贊成「這API的規格是足夠的」

看更多先前的回應...收起先前的回應...
suellen iT邦新手 5 級 ‧ 2017-06-01 01:06:39 檢舉

非常謝謝海綿寶寶的回覆。我一直知道應是人的問題,只是因技術常識有限,無法判斷誰講的比較有理... >_<
看了你貼的swagger ui資料後,覺真的跟我家那個api文件工具很像。

我截了幾張圖,一個post和put的畫面,第三張圖為post執行後的樣子。
跟你的swagger ui 比一比,還真的蠻像的。只是swagger是直接寫出來,我家這個有些東西則需打資料跑執行後才會顯示出來(如Response Body中的內容)。

這些資料搭配prototype,真的就夠安卓前端開發了嗎?

再問一個可能是幼幼班小問題,put和post是不是也有 input / output的意涵在(我是否太執著在前端講的沒有input / output說明這件事情上?)?

http://ithelp.ithome.com.tw/upload/images/20170531/20105754xzuS4WqjI3.pnghttp://ithelp.ithome.com.tw/upload/images/20170531/201057542V7sZz2qbC.pnghttp://ithelp.ithome.com.tw/upload/images/20170531/20105754MN7G1z6gis.pnghttp://ithelp.ithome.com.tw/upload/images/20170531/20105754nsM3Sx8D1D.png

希望有機會可再幫忙釋疑一下了,無論結果如何都非常謝謝您的幫忙。

感恩 :D

先講結論,「這些資料搭配prototype,真的就夠安卓前端開發了嗎?」....我認為是的

PUT/POST只是HTTP協定中的一部份
所謂的input/output
已經寫在文件中
input:「請求參數」,Request URL
output:Response Body/Code/Headers

最後再給你一點小小建議
如果你不是靠技術走跳的話
那就得多花點心思把搞定
(既然不懂技術,就不要去當裁判)
搞技術的人很死腦筋
跟你要好的人會淋漓盡致地幫你
跟你不同國的人會用一大堆技術門檻刁難你

Good luck.

萬一真的得選邊站,你又不知道怎麼選時
請想想電影寒戰中李文彬副處長的經典台詞
「一個城市,可以沒有ICAC,還是可以沒有警察?」
/images/emoticon/emoticon13.gif

再囉嗦一句
在專案管理的過程中
你與其在乎所謂的「對錯」
還不如去判斷
誰對專案的完成比較有幫助
誰是專案進行關鍵性的因素
/images/emoticon/emoticon68.gif

suellen iT邦新手 5 級 ‧ 2017-06-03 21:30:52 檢舉

謝謝您,真的太.....有幫助了,我知道該怎做了~
(其實我在I/O解釋那邊有點混亂,您解釋得如此清楚,立刻海闊天空了~
/images/emoticon/emoticon51.gif)
在目前資源不足的情況下,還不需選邊站,前端是說,沒給他I/O規格文件他沒法開發,既然夠用,那就先緩緩,先不煩惱這件事了~
繼續努力找資源或構思其他替代或補救方案才更重要~

謝謝、謝謝 & 謝謝 ^____^

我要發表回答

立即登入回答