朋友公司新專案，他負責後端開發，因為之前做過全棧的專案，基本前後臺思路都門清，就自己把邏輯走通寫了api介面，新招了個ios過來說他寫的介面不行，就幹了一架。
那麼介面文件到底是該誰來定義呢？
在平時的開發過程中，前後端經常會進行資料互動，那麼在前後端分離的專案中，前端就不用管後台的工作，用api調取資料即可。
筆者認為一般介面文件一定是後端來寫，只是我們要事先要和前端商量定義，然後再編寫介面文件，之後大家都根據這個介面文件進行開發，到專案結束前都要一直維護。
通俗一點就是：客戶端出介面需求，服務端出介面方案。
1、專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發
2、專案維護中或者專案人員更迭，方便後期人員檢視、維護
首先介面分為四部分：方法、url、請求引數、返回引數
1、方法:新增(post) 修改(put) 刪除(delete) 獲取(get)
3、請求引數和返回引數，都分為5列：字段、說明、型別、備註、是否必填
4、返回引數結構可以有乙個結構體也可以有多個結構體
eolinker，apidoc都是開源的專案有興趣可了解，可自己搭建測試api和自動生成api文件
SwaggerUI匯出離線Markdown文件說明
swaggerui匯出離線markdown文件說明 趟過很多坑，最後看到這篇文章，嘗試了一下，這個方法算是比較簡單奏效的方法。新增依賴庫 其中，springfox swagger2要2.9.2以上，低版本使用會有很多異常問題，所以 中使用是springfox swagger2最好公升級到2.9.2以...
yapi 介面文件 介面文件神器YApi
阿八個人部落格 1190000020220258 什麼是yapi github 官網上是這麼介紹的 yapi 是乙個可本地部署的 打通前後端及qa的 視覺化的介面管理平台 可以這麼說yapi兼具swagger,rap2,postman的各項優點why yapi 如果你想要乙個好用的介面管理平台，那麼...
Android 介面文件
前言 一 設定描述 設計描述，主要是介紹專案介面文件的業務及主要功能介紹，有互動方式 json資料互動格式 命名規則等做細分講解。1 介面的呼叫方式 移動端通過webservice和其他通用的請求方式，呼叫伺服器介面，返回json資料。2 json的結構 請求失敗示例 請求成功示例 字段解析 sta...