怎么看待一些后端程序員不寫接口文檔?
這種現(xiàn)象普遍存在,尤其是一些小公司。根本就沒有這么多時(shí)間來寫這玩意,因?yàn)樾枨箅S時(shí)改。很多公司一開始也是堅(jiān)持寫接口文檔,寫著寫著就不寫了。原因有以下幾點(diǎn):
一、需求改動(dòng)太頻繁寫借口文檔無形中縮短前后端聯(lián)調(diào)接口的時(shí)間。前后端定義好,然后就按照接口定義來走,減少了溝通成本。新接手的人也知道該怎么規(guī)范起來。但理想很豐滿,現(xiàn)實(shí)很骨感。有一句話說得好,做開發(fā)的永遠(yuǎn)不要相信產(chǎn)品的話,一個(gè)項(xiàng)目就是在不斷的更改中才會(huì)慢慢的成長。即便是非常優(yōu)秀的產(chǎn)品經(jīng)理,他也無法阻擋需求的更改。優(yōu)秀的產(chǎn)品經(jīng)理只能說避免很多沒有必要的需求,考慮的更全面一點(diǎn)。
一旦需求改的太頻繁,需求多了,也就是忙起來了,寫代碼的時(shí)間都不夠,就不會(huì)寫什么接口文檔了。直接把接口告訴前端,前端再打印出來,看看是什么格式,然后根據(jù)需要傳的參數(shù)來進(jìn)行聯(lián)調(diào)。其中遇到什么問題就再反饋給后端。
隨著這樣的習(xí)慣,慢慢的后端就更不寫接口詳細(xì)文檔了。不過這樣有一個(gè)弊端,那就是有人員變動(dòng)的時(shí)候,這參與進(jìn)來的成本就大很多。更何況每個(gè)人寫代碼的風(fēng)格不太一樣。
二、沒這個(gè)要求、沒這個(gè)習(xí)慣其實(shí)聯(lián)調(diào)接口,對著文檔來,真的是減少了前端的開發(fā)工作量。但是很多公司技術(shù)部門老大沒有這方面的規(guī)定。所以誰都想能偷懶就偷懶,你前端人員讓他們寫,他們是不會(huì)聽你的。因?yàn)槟悴皇撬麄兊睦洗蟆?/p>
我上家公司就是這樣,后端有四個(gè)人,每個(gè)人寫的接口格式都不一樣。同樣的一個(gè)字段名,有的人是這個(gè)單詞,有的人是那個(gè)單詞,甚至有的人類型都不一樣,他們從來也沒有寫接口需求的習(xí)慣。因?yàn)榍皫啄昵昂蠖朔蛛x不是那么火,前端做的工作僅僅就是把設(shè)計(jì)師設(shè)計(jì)的圖,然后切成靜態(tài)頁面。然后丟給后端,后端聯(lián)調(diào)接口就不需要什么接口文檔了。后端怎么寫的他自己都知道。
三、不想背鍋因?yàn)閷懡涌谖臋n不僅僅規(guī)范起來,其實(shí)也是一個(gè)證據(jù)的證明。如果后端的人開始寫了這個(gè)定義,后面沒有按照這個(gè)來,出了問題,到時(shí)候鍋想甩都甩不掉。
另外直接說不想寫,到時(shí)候你告訴領(lǐng)導(dǎo),寫文檔是那個(gè)人不想寫,估計(jì)也少不了一頓批。以忙為由,這樣領(lǐng)導(dǎo)聽起來就可以理解。
個(gè)人觀點(diǎn)我個(gè)人覺得很有必要把這個(gè)需求文檔規(guī)范起來,既然大家是一個(gè)團(tuán)隊(duì),如果不規(guī)范起來,這樣不僅不能提高開發(fā)效率,反而后期出現(xiàn)的問題也會(huì)越來越多。團(tuán)隊(duì)是需要磨合的,而不是隨心所欲的,團(tuán)隊(duì)不磨合,那這個(gè)團(tuán)隊(duì)永遠(yuǎn)不會(huì)強(qiáng)大起來,甚至可以說是一盤散沙。
規(guī)范不是按照一個(gè)人的的意思來,而是大家都提出有用的建議,把各個(gè)人的優(yōu)點(diǎn)都集中起來。然后大家都按照這個(gè)規(guī)則按一處使勁,這樣的產(chǎn)品才會(huì)越來越好。你覺得呢?