文章目錄

• 一、前言
• 二、接口文檔在線平臺(tái)
• • 1.apizza
  • • 1.1 文檔導(dǎo)出html
    • 1.2 導(dǎo)入Postman.json和Swagger.json文件
  • 2. YApi
  • • 2.1 源碼開源&免費(fèi)&支持二次開發(fā)
    • 2.2 [只能]內(nèi)網(wǎng)部署
    • 2.3 支持自動(dòng)化測(cè)試
    • 2.4 支持導(dǎo)入 Postman HAR Swagger JSON
    • 2.5 支持導(dǎo)出 html markdown json
  • 3. RAP 2
  • • 3.1 導(dǎo)出 Postman Collection
    • 3.2 支持 mockjs
  • 4. eolinker
  • • 4.1 功能完善
    • 4.2 付費(fèi)功能
• 三、文檔在線平臺(tái)
• • 1. 語雀
  • 2. 石墨文檔
  • 3. Github的wiki
• 四、文件管理平臺(tái)
• • 1. Github
• 五、總結(jié)

一、前言

作為一個(gè)公司的技術(shù)部門，就會(huì)涉及到一些文檔的對(duì)接，包括但不僅局限于

• 需求文檔
• 會(huì)議記錄
• 接口文檔
• 切圖標(biāo)注

對(duì)接的部門，包括但不僅局限于

• 前端和后端
• 移動(dòng)端和后端
• 設(shè)計(jì)和前端
• 設(shè)計(jì)和移動(dòng)端
• 產(chǎn)品經(jīng)理和開發(fā)
• 老板和產(chǎn)品經(jīng)理

那么，在這些溝通中產(chǎn)生的文檔，該怎么保存、歸檔，該怎么閱讀、使用，就成了團(tuán)隊(duì)協(xié)作提升溝通效率中重要的一個(gè)環(huán)節(jié)。

接下來，我列舉了一些工具，供開發(fā)人員和項(xiàng)目管理人員選擇，根據(jù)自己的實(shí)際情況選出對(duì)應(yīng)的解決方案。

二、接口文檔在線平臺(tái)

這里處理的問題是前端和后端交互，產(chǎn)生的一些接口文檔，這些文檔格式統(tǒng)一，但變更很快，并且修改之后看起來并不明顯，如果開發(fā)團(tuán)隊(duì)有異地協(xié)作和遠(yuǎn)程辦公，溝通又是個(gè)問題。

1.apizza

apizza的定位是api協(xié)作管理工具 ，官網(wǎng)地址為 https://apizza.net/

他的首頁是這樣的

實(shí)際使用界面是這樣的

emmmm，實(shí)際上就是一個(gè)線上版本的Postman…

有幾個(gè)亮點(diǎn)功能，如果你正好需要的話，可以酌情加分~

1.1 文檔導(dǎo)出html

導(dǎo)出的樣子是這樣的

很方便前端和移動(dòng)端的同學(xué)閱讀，不知道比那些word文檔強(qiáng)到哪里去了~

1.2 導(dǎo)入Postman.json和Swagger.json文件

如果團(tuán)隊(duì)內(nèi)使用了Postman或者Swagger的話，就會(huì)讓操作更加連貫。

如果可以導(dǎo)出對(duì)應(yīng)的文件就好了~

2. YApi

YApi旨在為開發(fā)、產(chǎn)品、測(cè)試人員提供更優(yōu)雅的接口管理服務(wù)?？梢詭椭_發(fā)者輕松創(chuàng)建、發(fā)布、維護(hù) API

網(wǎng)站上的特性如下

他的界面是這樣的

好吧，貌似開源的項(xiàng)目并不是都很好看…

2.1 源碼開源&免費(fèi)&支持二次開發(fā)

注意的是，這個(gè)項(xiàng)目是開放源代碼的，也就意味著更安全，更可維護(hù)，你可以直接去反饋bug，讓他做的更好。

項(xiàng)目地址為 https://github.com/ymfe/yapi

2.2 [只能]內(nèi)網(wǎng)部署

項(xiàng)目開源帶來的好處就是可以自己部署到內(nèi)網(wǎng)上，保證數(shù)據(jù)的安全性。

同時(shí)YApi不提供公共的版本供大家注冊(cè)使用，也就是需要我們自己的團(tuán)隊(duì)必須去部署。

2.3 支持自動(dòng)化測(cè)試

2.4 支持導(dǎo)入 Postman HAR Swagger JSON

嗯！

2.5 支持導(dǎo)出 html markdown json

嗯！

3. RAP 2

為什么不是RAP呢，因?yàn)?#34;RAP1功能不會(huì)再增加啦，新項(xiàng)目推薦使用RAP2哦"~
RAP 2是一個(gè)可視化接口管理工具，淘寶團(tuán)隊(duì)做的。
RAP1就不看了，直接看RAP2的網(wǎng)站。
經(jīng)過注冊(cè)登錄，RAP 2的結(jié)構(gòu)更像是Github。

有一個(gè)單獨(dú)的狀態(tài)頁面展示全網(wǎng)的活躍度，說明你并不孤獨(dú)。

其中接口的返回值是通過填寫對(duì)應(yīng)的數(shù)據(jù)和規(guī)則生成的，而不是復(fù)制對(duì)應(yīng)的json，這樣做更有利于測(cè)試工作。

3.1 導(dǎo)出 Postman Collection

看來大家都習(xí)慣于兼容Postman，這也間接說明了Postman這個(gè)工具的成功~

3.2 支持 mockjs

mockjs也是淘寶團(tuán)隊(duì)做的工具，“生成隨機(jī)數(shù)據(jù)，攔截 Ajax 請(qǐng)求”。

4. eolinker

https://www.eolinker.com/

免費(fèi)使用，API文檔管理、自動(dòng)化測(cè)試、開發(fā)協(xié)作利器

在經(jīng)歷過 注冊(cè) -> 驗(yàn)證郵箱 -> 填寫問卷 -> 幫助指南 之后，實(shí)例項(xiàng)目的接口編輯頁面是這樣的

從使用者的角度來講，這個(gè)的操作更加便利，雖然也是按Postman的樣式去做的~

4.1 功能完善

eolinker是一款完整的商業(yè)化的接口管理工具，基本用到的功能，在上面都能找到，并且操作和用戶體驗(yàn)做的都不錯(cuò)。

4.2 付費(fèi)功能

功能完善的代價(jià)就意味著，如果你想要使用全部完善的功能，就要付費(fèi)購買。

并且我們可以通過https://public.eolinker.com/index/EOLINKER%20AMS%20FUNCTION%20DETAIL%2020180520.pdf 來清晰的知道付費(fèi)版的功能是哪些。

三、文檔在線平臺(tái)

上面的平臺(tái)的針對(duì)性比較高，是專業(yè)的做接口文檔的，還有一種是只做文檔共享的，如果我們的目的是接口文檔管理，針對(duì)性就會(huì)差一些。

1. 語雀

語雀 https://www.yuque.com/ 是螞蟻金服做的一款文檔編輯共享平臺(tái)。

由于文檔是可以全面公開的，所以，給我的感覺更像是簡書。 😃

語雀以知識(shí)庫作為文檔的載體，可以選擇在線編輯和分享給其他用戶，注意是不能導(dǎo)出文件的哦。

如果作為內(nèi)部工具使用的話，不是很推薦。

2. 石墨文檔

石墨文檔的側(cè)重點(diǎn)更傾向于大家一起修改文件。

缺點(diǎn)也正是因?yàn)榇蠹铱梢酝瑫r(shí)修改文件，造成的文件版本混亂。

石墨文檔更傾向于存儲(chǔ)一些定值的項(xiàng)目資料，而不是注重版本和變更的接口文檔。

3. Github的wiki

wiki有天生的優(yōu)點(diǎn)

• 和項(xiàng)目綁定，這個(gè)項(xiàng)目的文檔就寫在這個(gè)項(xiàng)目的wiki中
• 版本控制和歷史回溯，因?yàn)楹虶ithub一樣的管理方式，保證了良好的版本控制

缺點(diǎn)也在于，如果這個(gè)文檔覆蓋了多個(gè)項(xiàng)目，就只好單獨(dú)開一個(gè)文檔的項(xiàng)目。

四、文件管理平臺(tái)

1. Github

本文中按范圍的涉及越來越廣，從局限使用和格式的專業(yè)接口管理平臺(tái)，到限制文字不限制內(nèi)容的文檔管理平臺(tái)，最終就指向了不限制文件格式的文件管理平臺(tái)，那么這個(gè)非Github莫屬了~

我們可以用于管理

• 代碼項(xiàng)目
• 設(shè)計(jì)師設(shè)計(jì)和切圖
• 各種協(xié)議和文檔
• …

限制越少，對(duì)應(yīng)的復(fù)雜度也就越多，如果控制的接口文件格式排版不友好，帶來的舒適度也會(huì)直線下降，不過這些都是沒辦法的。

五、總結(jié)

本文根據(jù)專業(yè)程度范圍，討論了這類在線管理平臺(tái)的優(yōu)缺點(diǎn)，列出了一些行業(yè)內(nèi)常見的工具平臺(tái)。

工具各種各樣，都有自己存在的價(jià)值，更重要的是根據(jù)我們自己的實(shí)際需求，選擇最適合自己的產(chǎn)品。

😃

總結(jié)

以上是生活随笔為你收集整理的【工具】目前几种常见的线上接口文档管理平台的比较的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。