鍍金池/ 問(wèn)答/Java  PHP  Python  Ruby  HTML/ 適合寫(xiě)接口文檔的工具,或者文本語(yǔ)法

適合寫(xiě)接口文檔的工具,或者文本語(yǔ)法

由于后端與前端使用ajax交互,后端寫(xiě)接口文檔變得非常有必要。以前我習(xí)慣用word寫(xiě)接口文檔,但是最近與同事合作編寫(xiě)后端,word并不適合使用svn工具做同步,因?yàn)閟vn、git等無(wú)法自動(dòng)合并word。所以打算把文檔寫(xiě)成文本的格式。

一開(kāi)始想到的是用markdown語(yǔ)法來(lái)寫(xiě)。markdown語(yǔ)法大全

但是接口文檔最重要的一個(gè)特性是,接口多,需要給每個(gè)接口標(biāo)序號(hào)(如下圖)。
當(dāng)然markdown支持序號(hào),但是支持得并不完美,比如上下兩個(gè)序號(hào)之間最多只能有一個(gè)空行,并且空行不能寫(xiě)文字,這樣就只能光寫(xiě)接口標(biāo)題了,沒(méi)有空間寫(xiě)接口內(nèi)容了。

請(qǐng)問(wèn)適合寫(xiě)接口文檔的方法是什么?最好就是一種語(yǔ)法,而不是一個(gè)軟件

clipboard.png


感謝大家的回答,考慮到markdown目前的趨勢(shì),還是決定繼續(xù)使用markdown,現(xiàn)在已經(jīng)想到解決辦法,markdown只是一種語(yǔ)法,到底怎么顯示,還是由軟件或者瀏覽器插件來(lái)決定的,我找到兩款chrome插件

Markdown Preview Plus

能自動(dòng)把原文中的標(biāo)題提取出來(lái)生成目錄,并且能給目錄自動(dòng)加序號(hào)(如果原文標(biāo)題本身就有序號(hào),它也會(huì)加自己的序號(hào),所以原文標(biāo)題不能有序號(hào))

clipboard.png

Markdown Viewer

同樣能把原文中的標(biāo)題提取出來(lái)生成目錄,但是不會(huì)加序號(hào),對(duì)于不需要序號(hào),或者接口較少的,可以用這個(gè),我更喜歡這個(gè)插件的目錄樣式,可惜功能缺了一點(diǎn)。

clipboard.png


這兩款插件其實(shí)是提供給文檔閱讀者的,文檔編輯者倒是可以不需要,全看個(gè)人喜好了,chrome官方市場(chǎng)里就找到這兩款了,不知道國(guó)內(nèi)有沒(méi)有人開(kāi)發(fā)了插件沒(méi)傳到chrome市場(chǎng)

回答
編輯回答
莓森
2017年2月26日 11:35
編輯回答
故林
2017年5月22日 10:55
編輯回答
過(guò)客

apidoc 還挺好用的

2017年2月3日 04:23
編輯回答
幼梔

APIJSON自動(dòng)化在線(xiàn)解析
完全自動(dòng)生成文檔,自動(dòng)管理測(cè)試用例,不用寫(xiě)任何代碼
http://39.108.143.172/

圖片描述

2017年12月28日 17:40
編輯回答
命于你

GitBook或者Swagger-UI都可以。比較推薦Swagger-UI,在寫(xiě)代碼的時(shí)候添加注釋即可生成文檔。

2017年2月19日 17:43
編輯回答
心悲涼

postman

2017年5月31日 14:58
編輯回答
雨蝶

Showdoc挺好用的

2018年9月3日 07:14
編輯回答
入她眼

Swagger. 通過(guò)固定格式的注釋生成文檔. 省時(shí)省力

2018年5月30日 00:31
編輯回答
別瞎鬧

一直在用RAP,使用起來(lái)很簡(jiǎn)單RAP

2017年1月12日 23:04