適合寫api接口文檔的管理工具有哪些?


簡書原文:https://www.jianshu.com/p/d7b13670e0eb

適合寫api接口文檔的管理工具有哪些?

62018.08.18 16:28:12字數 1,414閱讀 77,737

現在越來越流行前后端分離開發,使用ajax交互。所以api接口文檔就變的十分有意義了,目前市場有哪些比較優秀的接口文檔管理工具呢?

一鍵導入,點擊復制,方便快捷

鏈接地址:https://easydoc.xyz/

 
image.png

 

 
image.png

1.Showdoc:

一個非常適合IT團隊的在線API文檔、技術文檔工具。

 

 
image.png

網址:https://www.showdoc.cc/

2.eoLinker

eoLinker擁有業內最強的接口管理功能,無論你是創業團隊還是成熟企業,eoLinker將滿足你的所有接口管理需求。在eoLinker上編寫或者導入接口文檔,邀請團隊成員加入項目,接着進行在線的接口測試,並且提供Mock接口給前端進行對接,后續通過完善的文檔版本管理以及團隊協作功能,不斷地對項目進行迭代,提高項目整體的開發效率!

 

 
image.png
 
image.png

主要功能

  • 快速全面地管理接口文檔 :1.UI可視化文檔,2. 支持表單、RESTful、Raw等設計規范,3. 通過注釋生成文檔,4. 版本管理,5. 支持富文本/Markdown,6. 分組管理,7. 星標標注。
  • 測試接口是否正常運作:1. 支持在線、本地(localhost)測試,2. 支持跨域測試,3. 支持文件測試,4. 強大的參數構造器。
  • Mock API實現敏捷開發:1. 根據文檔自動生成校驗數據,2. 支持請求協議、請求方式校驗,3. 支持簡易Mock、高級Mock(MockJS),4. 支持跨域調用。
  • **了解團隊成員動向: **1. 團隊人員管理,,2. 支持設置人員讀寫權限,3. 支持成員昵稱,4. 支持通過鏈接邀請成員。
  • 專業版:1. 強大的插件支持,2. 代碼生成,3. 測試用例,4. 空間日志,5. 高級權限管理,6. 5天 * 10小時 專業客戶成功部門一對一支持。

網址:https://www.eolinker.com/#/

3.MinDoc

MinDoc 是一款針對IT團隊開發的簡單好用的文檔管理系統。MinDoc 的前身是 SmartWiki 文檔系統。SmartWiki 是基於 PHP 框架 laravel 開發的一款文檔管理系統。因 PHP 的部署對普通用戶來說太復雜,所以改用 Golang 開發。可以方便用戶部署和實用,同時增加Markdown和HTML兩種編輯器。其功能和界面源於 kancloud 。

 

 
image.png

[](javascript:;)主要功能

  1. 項目管理,可以對項目進行編輯更改,成員添加等。
  2. 文檔管理,添加和刪除文檔,文檔歷史恢復等。
  3. 用戶管理,添加和禁用用戶,個人資料更改等。
  4. 用戶權限管理 , 實現用戶角色的變更。
  5. 項目加密,可以設置項目公開狀態,私有項目需要通過Token訪問。
  6. 站點配置,二次開發時可以添加自定義配置項。
  7. 附件管理,可管理所有項目中上傳的文件。
  8. 項目導出,目前支持導出 PDF 格式項目。
  9. 系統日志。

網址:https://www.iminho.me/

4.apizza

極客專屬的api協作管理工具 免費的團隊協作,在線模擬調試,快速生成api文檔,導出離線版文檔

 
image

主要功能

  1. api跨域調試量身定制的chrome插件,本地,在線接口,都可以調。

  2. 免費的團隊協作 免費的團隊協作工具,極致的文檔編寫體驗,加快開發效率。

  3. 安全的雲端存儲 安全可靠的雲端存儲服務,企業安全版支持本地數據中心。

  4. 一鍵分享 與團隊共享你的API文檔。

  5. 支持Postman,Swagger格式 導入Postman/Swagger Json 生成文檔。

  6. 導出離線文檔 導出離線文檔,部署本地服務器。

  7. api Mock 根據文檔自動生成返回結果,提供獨立URL方便前端測試

  8. 支持多種文檔 http接口文檔,markdown說明文檔
    [圖片上傳中...(image.png-150c34-1539666393114-0)]

網址:http://apizza.cc/

5.RAML

用 YAML 文件格式編寫,強大的官方支持,官方提供 atom 插件,支持語法智能提示及校驗,編寫快速簡單。

 
image

主要功能

  1. 支持 examples
  2. 支持 schema 校驗
  3. 支持工具測試

網址:https://raml.org/

5.其他工具

1.Swagger:

通過固定格式的注釋生成文檔. 省時省力,不過有點學習成本。

網址:https://swagger.io/

2.apidoc:

可以根據代碼注釋生成web api文檔,web接口的注釋維護起來更加方便,不需要額外再維護一份文檔。

網址:http://apidocjs.com/

3.RAP:

一個可視化接口管理工具 通過分析接口結構,動態生成模擬數據,校驗真實接口正確性, 圍繞接口定義,通過一系列自動化工具提升我們的協作效率。

網址:http://rap.taobao.org/org/index.do

4.APIJSON:

客戶端可以定義任何JSON結構去向服務端發起請求,服務端就會返回對應結構的JSON字符串,所求即所得。

網址:http://jsonapi.org/


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM