后端開發(fā)完接口才給出接口文檔，合理嗎？你怎么看？一個非常好的問題，我是工作多年的Web應(yīng)用架構(gòu)師，來回答一下這個問題。歡迎關(guān)注我，了解更多IT專業(yè)知識。后端給出接口文檔太晚，也合理也不合理，要看具體情

后端開發(fā)完接口才給出接口文檔，合理嗎？你怎么看？

一個非常好的問題，我是工作多年的Web應(yīng)用架構(gòu)師，來回答一下這個問題。歡迎關(guān)注我，了解更多IT專業(yè)知識。

后端給出接口文檔太晚，也合理也不合理，要看具體情況，總有解決方法，我來說一下我的觀點。

不合理：成熟的技術(shù)團隊，重視功能設(shè)計，在動手寫代碼之前已經(jīng)有了完整的技術(shù)文檔和功能定義，甚至在TDD測試驅(qū)動開發(fā)模式中，測試數(shù)據(jù)已經(jīng)準(zhǔn)備就緒，那么這時接口文檔不管寫沒寫，接口邏輯都是已經(jīng)確定的，整理出來是水到渠成。

合理：多存在于早期小型創(chuàng)業(yè)公司，主觀客觀原因都有。

- 先說主觀原因。趕進度、沒時間、懶得寫，甚至開發(fā)前都沒做仔細的設(shè)計，邊做邊改，這些原因普遍存在，也實在沒啥好辦法。

- 客觀原因，需求在變，功能跟著變，接口也要變，那么如果寫了文檔，理所當(dāng)然也要更新維護??？我的天哪。

有解決方法嗎？建議試試：

1，Swagger接口文檔，將文檔融合到代碼中，讓維護文檔和修改代碼整合為一體，使得修改代碼邏輯的同時方便的修改文檔說明。

2，Postman接口測試工具，導(dǎo)入導(dǎo)出JSON文件，高效團隊協(xié)作。Postman支持各種請求方式和配置環(huán)境變量，并對返回結(jié)果進行測試校驗，支持批量自動化運行，可以和自動構(gòu)建系統(tǒng)集成。

api文檔是什么？

API:Application ProgrammingInterface(應(yīng)用編程適配器)， 語言、框架以及類庫對外提供的編碼的適配器

當(dāng)您安裝 Visual C 6.0時，您將得到一個包括API文件的線上求助系統(tǒng)。您可通過訂閱MSDN或使用Microsoft網(wǎng)站上的線上求助系統(tǒng)更新該文件。

如何使WebAPI自動生成漂亮又實用在線API文檔？

1、如何引入組件

首先，我們需要定義一個api項目

然后通過nuget引入組件。記住選下圖中的第三個。

引入成功后，將向項目里面添加一些主要文件：

?scriptswebapitestclient.js

?areashelppagetestclient.css

?areashelppageviewshelpdisplaytemplatestestclientdialogs.cshtml

?areashelppageviewshelpdisplaytemplatestestclientreferences.cshtml

2、如何使用組件

1、修改api.cshtml文件

通過上述步驟，就能將組件webapitestclient引入進來。下面我們只需要做一件事：打開文件(根據(jù)areashelppageviewshelp)api.cshtml并添加以下內(nèi)容:

?@html.displayformodel("testclientdialogs")

?@html.displayformodel("testclientreferences")