微信api文檔 怎么看待一些后端程序員不寫(xiě)接口文檔,老是以很忙為借口搪塞?
怎么看待一些后端程序員不寫(xiě)接口文檔,老是以很忙為借口搪塞?不寫(xiě)接口文檔,一般很忙?;蛘邲](méi)有時(shí)間整理文件。對(duì)于前端和后端的對(duì)接,前端開(kāi)發(fā)人員一般需要后端人員提供接口文檔,而現(xiàn)在招搖過(guò)市的文檔完全可以提供
怎么看待一些后端程序員不寫(xiě)接口文檔,老是以很忙為借口搪塞?
不寫(xiě)接口文檔,一般很忙?;蛘邲](méi)有時(shí)間整理文件。
對(duì)于前端和后端的對(duì)接,前端開(kāi)發(fā)人員一般需要后端人員提供接口文檔,而現(xiàn)在招搖過(guò)市的文檔完全可以提供這個(gè)功能。在許多情況下,后端開(kāi)發(fā)人員集成了一個(gè)swagger并自動(dòng)生成相應(yīng)的文檔。
您可以給后端開(kāi)發(fā)人員一定的時(shí)間來(lái)學(xué)習(xí)swagger或?qū)wagger集成到項(xiàng)目中。
如何使WebAPI自動(dòng)生成漂亮又實(shí)用在線API文檔?
1. 如何導(dǎo)入組件
首先,我們需要定義一個(gè)API項(xiàng)目
然后通過(guò)nuget導(dǎo)入組件。記住選擇下圖中的第三個(gè)。
導(dǎo)入成功后,一些主文件將添加到項(xiàng)目中:?腳本 webapitestclient.js網(wǎng)站
?區(qū)域幫助頁(yè) 測(cè)試客戶端.css
?區(qū)域幫助頁(yè)視圖幫助顯示模板testclientdialogs.cshtml
?區(qū)域幫助頁(yè)視圖幫助顯示模板testclientreferences.cshtml文件
2. 如何使用組件
1api.cshtml文件[document
通過(guò)以上步驟,我們可以引入組件webapitestclient?,F(xiàn)在我們只需要做一件事:打開(kāi)文件(根據(jù)areashelppageviewshelp)api.cshtml文件并添加以下內(nèi)容:
@html.displayformodel文件(“testclientdialogs”)?@ html.displayformodel文件(“testclientreferences”)