後端老是不寫介面文件？說自己很忙？

阿新 • • 發佈：2021-12-13

自從前端和後端分家之後，前後端通過介面對接就成為了日常，誰也離不開誰，而對接介面的過程就離不開介面文件。

理想的前後端均衡的團隊裡，流程一般是這樣：
1、大家一塊討論需求，分析實現細節；
2、由前端或後端中的一方提出來一版初版介面文件大家來討論；
3、最後討論定了後大家各自進行程式開發實現，當然這個過程中會有一些欄位細節的增刪調整，不過一把大結構上是不會有太大變化了。

這種理想情況下，哪一邊出介面文件，他們都是比較樂意的，因為這就相當於標準制定啊，誰來出誰就可以按自己方便的來。

不過嘛，實際情況往往都沒那麼理想，每個公司多多少少都會有前端偏向性或是後端偏向性，後端偏向性的結果之一，就是遲遲不給介面文件，美名其曰開發任務多，沒空寫文件了。

有需求了肯定就有解決方法，如果是開發 http api ，那麼一般都會用像Swagger、Eolink等介面文件管理工具來輔助介面文件的相關工作，這兩個工具也都支援先寫程式碼或先寫文件的兩種方式。
1、先寫程式碼，通過註解生成文件。/2、先寫文件，再借助工具生成程式碼腳手架，然後填充業務邏輯部分。

在國內，先寫程式碼再自動生成文件的方式特別常見，筆者通常都是用的Eolink，功能和Swagger差不多，但是因為是國內團隊設計的，服務支援比較方便。編輯好API模板，就可以直接生成規範的介面文件，API有修改也可以一鍵同步到介面文件。

而先寫文件再寫程式碼的所謂 design first 方式極其罕見，筆者在工作中至今沒見過一例，也只在個人專案中實踐過這種方式，不算熟悉，就不多講了。