一.什麼是接口html
API（Application Programming Interface）即應用程序接口，能夠任務是一個軟件組件或一個Web服務與外界進行交互的接口，在這裏接口能夠和API劃等號。後端
二.爲何編寫接口文檔api
一、項目開發過程當中先後端工程師有一個統一的文件進行溝通交流開發markdown
二、項目維護中或者項目人員更迭，方便後期人員查看、維護工具
三、測試人員驗證檢查接口是否正確post
三.接口文檔有誰編寫測試
正規的團隊合做或者是項目對接，接口文檔是很是重要的，通常接口文檔都是經過開發人員寫的。一個工整的文檔顯得是非重要。spa
四.接口文檔格式3d
1.在線版格式htm
2.word版格式
這就是接口文檔的格式如何編寫的了，我這裏不是用本身手寫的，而是用的一款叫apipost的接口測試和接口文檔生成工具生成的，它還能夠生成html和markdown格式的接口文檔。
不想本身寫文檔的同窗能夠是去試試這款軟件。