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

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

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

后端給出接口文檔太晚，也合理也不合理，要看具體情況，總有解決方法，我來(lái)說(shuō)一下我的觀點(diǎn)。

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

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

- 先說(shuō)主觀原因。趕進(jìn)度、沒(méi)時(shí)間、懶得寫(xiě)，甚至開(kāi)發(fā)前都沒(méi)做仔細(xì)的設(shè)計(jì)，邊做邊改，這些原因普遍存在，也實(shí)在沒(méi)啥好辦法。

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

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

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

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

前端嫌我接口分的太多，我該怎么回答？該怎么操作？

我們的框架也是前后臺(tái)分離。后端接口的多少應(yīng)該根據(jù)業(yè)務(wù)合理劃分，而不是誰(shuí)覺(jué)得多不方便，開(kāi)發(fā)不能只從方便入手。整體上接口設(shè)計(jì)的多少應(yīng)從以下幾個(gè)方面考慮：

1、接口粒度的細(xì)分考慮職責(zé)單一，還得考慮多個(gè)操作是否應(yīng)該在同一事物中，若在同一事物中接口的粒度可設(shè)計(jì)大一點(diǎn)。

2、接口的合并問(wèn)題，當(dāng)有多次請(qǐng)求不同接口而返回?cái)?shù)據(jù)量又不大的時(shí)候可酌情將接口進(jìn)行合并。

3、接口的拆解問(wèn)題，當(dāng)一次返回?cái)?shù)據(jù)量過(guò)大導(dǎo)致傳輸慢的時(shí)候，根據(jù)業(yè)務(wù)得拆成多個(gè)接口，并要分析哪些數(shù)據(jù)先請(qǐng)求，哪些后請(qǐng)求。

4、接口重復(fù)問(wèn)題，比如PC應(yīng)用和移動(dòng)應(yīng)用用到同一組數(shù)據(jù)，后臺(tái)針對(duì)PC和移動(dòng)端應(yīng)用開(kāi)發(fā)了兩個(gè)接口，這種情況下可以刪除一個(gè)接口。

5、接口停止服務(wù)問(wèn)題，舉個(gè)例子，在618，雙11時(shí)很多商品有促銷(xiāo)活動(dòng)（提供的接口），當(dāng)過(guò)了這兩天，完全可以把此類(lèi)服務(wù)停止減少負(fù)荷。

以上是我從實(shí)際項(xiàng)目角度做的分析，希望幫助到你，具體到項(xiàng)目中可深入探討。

API接口有什么作用？

我們常在軟件開(kāi)發(fā)或合作中遇到“API”這個(gè)詞，比如API接口、API調(diào)用、API接口函數(shù)等等，那么到底什么是API呢？

API用通俗的話說(shuō)，就相當(dāng)于大家經(jīng)常看的科幻電影中的空間站或宇宙飛船與其他航天設(shè)備對(duì)接的那個(gè)開(kāi)口。別人的航天飛機(jī)要跟你對(duì)接時(shí)，你必須告訴你的空間站的對(duì)外接口標(biāo)準(zhǔn)規(guī)格，比如接口名稱、接口尺寸、接口程序等等，才能保證最終兩者順利通過(guò)這個(gè)接口建立聯(lián)系，完成彼此內(nèi)容的交換。

API的標(biāo)準(zhǔn)說(shuō)法是Application Programming Interface，即應(yīng)用程序編程接口。

API是一些預(yù)先定義函數(shù)，目的是用來(lái)提供應(yīng)用程序與開(kāi)發(fā)人員基于某軟件或者某硬件得以訪問(wèn)一組例程的能力，并且無(wú)需訪問(wèn)源碼或無(wú)需理解內(nèi)部工作機(jī)制細(xì)節(jié)。這個(gè)也很好理解，一個(gè)標(biāo)準(zhǔn)軟件，比如今日頭條APP，就可以開(kāi)放API接口給別人，比如字節(jié)跳動(dòng)公司需要隨時(shí)了解今日頭條APP的用戶使用狀態(tài)，他們就可以讓今日頭條開(kāi)發(fā)一個(gè)名字叫“用戶狀態(tài)/User Status”的API接口，然后字節(jié)跳動(dòng)母公司就通過(guò)自己統(tǒng)計(jì)軟件獲取這個(gè)“User Status”函數(shù)的內(nèi)容，這樣今日頭條用戶總量、新增用戶量、用戶活躍狀態(tài)、熱點(diǎn)數(shù)據(jù)就會(huì)在字節(jié)跳動(dòng)的統(tǒng)計(jì)軟件屏幕上顯示出來(lái)，而該統(tǒng)計(jì)軟件不需要知道哪個(gè)用戶具體發(fā)布了哪些內(nèi)容，如果需要，也需要另外做API接口去調(diào)用。

所以，API就是操作系統(tǒng)給應(yīng)用程序的調(diào)用接口，應(yīng)用程序通過(guò)調(diào)用操作系統(tǒng)的 API而使操作系統(tǒng)去執(zhí)行應(yīng)用程序的命令（動(dòng)作）。在 Windows 中，系統(tǒng)API是以函數(shù)調(diào)用的方式提供的。

前端怎么調(diào)用api接口？

首先你必須要寫(xiě)一個(gè)調(diào)用的類(lèi)，然后這個(gè)類(lèi)里面直接將接口的地址給調(diào)用好之后，然后進(jìn)行連接，再通過(guò)其他的方式再調(diào)用這個(gè)類(lèi)，就可以使用這個(gè)API的接口了。