接口文檔生成工具

一、為什么要寫接口文檔？

1.正規(guī)的團(tuán)隊(duì)合作或者是項(xiàng)目對(duì)接，接口文檔是非常重要的，一般接口文檔都是通過(guò)開(kāi)發(fā)人員寫的。一個(gè)工整的文檔顯得是非重要。

2.項(xiàng)目開(kāi)發(fā)過(guò)程中前后端工程師有一個(gè)統(tǒng)一的文件進(jìn)行溝通交流開(kāi)發(fā)，項(xiàng)目維護(hù)中或者項(xiàng)目人員更迭，方便后期人員查看、維護(hù)

二、接口文檔的格式

接口主要分為四部分：方法、uri、請(qǐng)求參數(shù)、返回參數(shù)

三、接口文檔生成工具

apipost一款很不錯(cuò)的接口測(cè)試工具，它可以生成各種格式的接口文檔，有在線版的，markdown格式和word格式的接口文檔。

點(diǎn)擊分享當(dāng)前接口

分享

復(fù)制鏈接在瀏覽器中打開(kāi)

下載其他格式的接口文檔

word格式的接口文檔（word只支持json格式的排版，所以百度放回的數(shù)據(jù)格式在word中顯示不規(guī)范）

單個(gè)接口的word格式的接口文檔可以免費(fèi)下載，下載多個(gè)簡(jiǎn)單文檔和一個(gè)項(xiàng)目的接口文檔的時(shí)間就需要開(kāi)會(huì)員了。

還有就是apipost下載多個(gè)word格式的接口文檔的時(shí)候，每個(gè)接口是單獨(dú)的接口文檔需要合并。wps和office里面都有合并功能。

在插入中的對(duì)象中找到文件中的文字然后點(diǎn)擊選擇所有接口就可以合并了。

這就是接口文檔生成工具

apipost下載地址：https://www.apipost.cn/?dt=20201028