怎麼看待一些後端程序員不寫接口文檔,老是以很忙為藉口搪塞?

趣味影視站


這種現象普遍存在,尤其是一些小公司。根本就沒有這麼多時間來寫這玩意,因為需求隨時改。很多公司一開始也是堅持寫接口文檔,寫著寫著就不寫了。原因有以下幾點:

一、需求改動太頻繁

寫藉口文檔無形中縮短前後端聯調接口的時間。前後端定義好,然後就按照接口定義來走,減少了溝通成本。新接手的人也知道該怎麼規範起來。但理想很豐滿,現實很骨感。有一句話說得好,做開發的永遠不要相信產品的話,一個項目就是在不斷的更改中才會慢慢的成長。即便是非常優秀的產品經理,他也無法阻擋需求的更改。優秀的產品經理只能說避免很多沒有必要的需求,考慮的更全面一點。

一旦需求改的太頻繁,需求多了,也就是忙起來了,寫代碼的時間都不夠,就不會寫什麼接口文檔了。直接把接口告訴前端,前端再打印出來,看看是什麼格式,然後根據需要傳的參數來進行聯調。其中遇到什麼問題就再反饋給後端。

隨著這樣的習慣,慢慢的後端就更不寫接口詳細文檔了。不過這樣有一個弊端,那就是有人員變動的時候,這參與進來的成本就大很多。更何況每個人寫代碼的風格不太一樣。

二、沒這個要求、沒這個習慣

其實聯調接口,對著文檔來,真的是減少了前端的開發工作量。但是很多公司技術部門老大沒有這方面的規定。所以誰都想能偷懶就偷懶,你前端人員讓他們寫,他們是不會聽你的。因為你不是他們的老大。

我上家公司就是這樣,後端有四個人,每個人寫的接口格式都不一樣。同樣的一個字段名,有的人是這個單詞,有的人是那個單詞,甚至有的人類型都不一樣,他們從來也沒有寫接口需求的習慣。因為前幾年前後端分離不是那麼火,前端做的工作僅僅就是把設計師設計的圖,然後切成靜態頁面。然後丟給後端,後端聯調接口就不需要什麼接口文檔了。後端怎麼寫的他自己都知道。

三、不想背鍋

因為寫接口文檔不僅僅規範起來,其實也是一個證據的證明。如果後端的人開始寫了這個定義,後面沒有按照這個來,出了問題,到時候鍋想甩都甩不掉。

另外直接說不想寫,到時候你告訴領導,寫文檔是那個人不想寫,估計也少不了一頓批。以忙為由,這樣領導聽起來就可以理解。

個人觀點

我個人覺得很有必要把這個需求文檔規範起來,既然大家是一個團隊,如果不規範起來,這樣不僅不能提高開發效率,反而後期出現的問題也會越來越多。團隊是需要磨合的,而不是隨心所欲的,團隊不磨合,那這個團隊永遠不會強大起來,甚至可以說是一盤散沙。

規範不是按照一個人的的意思來,而是大家都提出有用的建議,把各個人的優點都集中起來。然後大家都按照這個規則按一處使勁,這樣的產品才會越來越好。你覺得呢?


阿智生活記


後端程序員只負責實現接口吧?


井151276607


前後端對接,一般前段開發人員一般都需要後端人員提供接口文檔,但是現在swagger文檔已經完全可以提供該功能。很多情況下後端開發程序員集成一個swagger進去,會自動生成相應的文檔。

可以給後端開發人員一定的時間去學習swagger或者集成swagger進項目。


凱騰凱


作為一名IT行業的從業者,我來回答一下這個問題。

首先,是否需要寫接口文檔往往與項目規模有比較直接的關係,一些大中型項目是一定要寫接口文檔的,這一點程序員通常也是比較清楚的,而且文檔的編寫通常也有一個專門的負責人,往往也需要多個程序員的配合才能完成。

程序員之所以不寫接口文檔,通常處於三方面原因,其一是項目規模本身很小,接口設計也比較簡單,此時程序員往往不會單獨抽出時間來寫接口文檔,實際上這部分工作很多人都可以完成,也沒有必要一定要讓程序員做;其二是項目本身的接口設計沒有最終敲定,此時程序員希望等接口確定之後再寫,這也是比較常見的原因之一;其三是程序員本身對於整個項目的接口不瞭解。

對於程序員來說,編寫接口文檔通常並不是一件很願意做的事情,除了以上幾點原因之外,程序員編寫接口文檔通常沒有單獨的任務指標,而且編寫接口文檔通常比較耗費時間,這也是很多程序員不願意編寫接口文檔的一個重要原因。實際上,在很多項目組中,項目經理通常會參與接口文檔的編寫工作,另外還會配備專門的人員來完成接口文檔的最終彙總。

正常情況下,接口文檔在最終生成之後,通常還需要一個詳細的校驗過程,這個過程需要根據接口文檔的描述,來完成對應接口的驗證。按照不同的項目應用場景,接口也會有不同的應用場景,通常會向不同的用戶開放不同的接口,此時也需要有詳細的說明。

我從事互聯網行業多年,目前也在帶計算機專業的研究生,主要的研究方向集中在大數據和人工智能領域,我會陸續寫一些關於互聯網技術方面的文章,感興趣的朋友可以關注我,相信一定會有所收穫。

如果有互聯網、大數據、人工智能等方面的問題,或者是考研方面的問題,都可以在評論區留言,或者私信我!


IT人劉俊明


因為壓根就不需要寫接口文檔,後端引入swagger接口文檔會自動生成,代碼改了接口文檔也會自動更新,同時前端不管是用web還是客戶端c#接口調用這塊的代碼都是可以自動生成的(注:js有jar包翻譯工具,c#可以用模板文件自動生成代碼),程序工資開那麼高,把精力放在沒有技術含量的寫文檔上不知道怎麼想的。


aoe6863


我們是小公司,接口都是寫在微信的tapd上,,建一個思維導圖,接口名字,路徑就寫在樹枝上,參數這備註中,一般只寫接口的請求參數,返回參數一般都是讓前端直接看數據庫一段註釋,偶爾返回值有特殊的,就在備註裡面上面再寫點


老飛的天空


一般公司都會開發一套自己的接口系統吧

後臺代碼一提交,自動根據接口在接口系統中生成接口文檔

前端可以查詢接口系統進行接口調用

後臺也可以在接口系統中進行接口測試

自動化生成~省


專治不服sawyer


接口文檔不能書寫 應由工具實時生成 因為接口會變化


陳劍波32


他只是個打工的,

1,眼光差,看不到全局

2,利益相關性弱,不追求最優

所以方法是:

1,賜予股份+培訓系統工程

2,強令,否則炒


wolfoxonly


講真,人家是真沒時間寫。。其實和公司大小無關。只是小公司更嚴重。原因就是:領導給你的任務時間永遠都不夠。更不要說,寫文檔的時間來了。

所有文檔基本都是項目完成以後,開發人員利用項目間隔慢慢補。[捂臉]


分享到:


相關文章: