和朋友聊天，他說他們公司開始了一個新專案，由他負責后端開發，因為之前做過全堆疊的專案，前后端開發思路都懂，就自己把邏輯走了一遍，寫了api介面，結果專案開發到一半，新招了個ios，上來就說他寫的介面不行吵了起來，

那么介面檔案到底是該誰來定義呢？

介面是什么？

API，全稱是ApplicationProgramming Interface，即應用程式編程介面，我們日常中習慣簡稱為“介面”，介面是一些預先定義的函式，目的是提供應用程式與開發人員基于某軟體或硬體的以訪問一組例程的能力，而又無需訪問原始碼，或理解內部作業機制的細節，

介面有什么用？

在平時的開發程序中，前后端經常會進行資料互動，那么在前后端分離的專案中，前端就不用管后臺的作業，用api調取資料即可，

介面檔案該由誰來寫呢？

筆者認為一般介面檔案一定是后端來寫，只是我們要事先要和前端商量定義，然后再撰寫介面檔案，之后大家都根據這個介面檔案進行開發，到專案結束前都要一直維護，
通俗一點就是：客戶端出介面需求，服務端出介面方案，

為什么要寫介面檔案？

1、專案開發程序中前后端工程師有一個統一的檔案進行溝通交流開發；
2、專案維護中或者專案人員更迭，方便后期人員查看、維護；

介面規范是什么？

首先介面分為四部分：方法、url、請求引數、回傳引數
1、方法:新增(post) 修改(put) 洗掉(delete) 獲取(get)；
2、url：uri地址里不允許出現大寫字母，如果是兩個單詞拼接，用/分開；
3、請求引數和回傳引數，都分為5列：欄位、說明、型別、備注、是否必填；
4、回傳引數結構可以有一個結構體也可以有多個結構體；

如何自動生成檔案？

最簡單的是找一個合適的工具，省去敲字對格式的痛苦，這里推薦的是Eolinker，一個適合不同規模開發團隊的在線API檔案工具，而且除了檔案部分的功能外，整個API開發流程的不同階段，都可以直接在Eolinker上進行，省事，

當然還有其他類似的平臺也可以滿足在線編輯規范介面的平臺：apidoc，sosoapi等
使用地址：www.eolinker.com

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/256618.html

標籤：其他

上一篇：設計標準的RESTful API