echarts4离线使用文档_适合写API接口文档的管理工具有哪些?
現(xiàn)在越來越流行前后端分離開發(fā),使用ajax交互。所以api接口文檔就變的十分有意義了,目前市場有哪些比較優(yōu)秀的接口文檔管理工具呢?
1、MinDoc
網(wǎng)址:https://www.iminho.me/
MinDoc 是一款針對IT團隊開發(fā)的簡單好用的文檔管理系統(tǒng)。MinDoc 的前身是 SmartWiki 文檔系統(tǒng)。SmartWiki 是基于 php 框架 laravel 開發(fā)的一款文檔管理系統(tǒng)。
因 php 的部署對普通用戶來說太復(fù)雜,所以改用 Golang 開發(fā)。可以方便用戶部署和實用,同時增加Markdown和html兩種編輯器。其功能和界面源于 kancloud 。
主要功能
- 項目管理,可以對項目進行編輯更改,成員添加等。
- 文檔管理,添加和刪除文檔,文檔歷史恢復(fù)等。
- 用戶管理,添加和禁用用戶,個人資料更改等。
- 用戶權(quán)限管理 , 實現(xiàn)用戶角色的變更。
- 項目加密,可以設(shè)置項目公開狀態(tài),私有項目需要通過Token訪問。
- 站點配置,二次開發(fā)時可以添加自定義配置項。
- 附件管理,可管理所有項目中上傳的文件。
- 項目導(dǎo)出,目前支持導(dǎo)出 PDF 格式項目。
- 系統(tǒng)日志。
2、eoLinker
網(wǎng)址:https://www.eolinker.com/#/
eoLinker擁有業(yè)內(nèi)最強的接口管理功能,無論你是創(chuàng)業(yè)團隊還是成熟企業(yè),eoLinker將滿足你的所有接口管理需求。
在eoLinker上編寫或者導(dǎo)入接口文檔,邀請團隊成員加入項目,接著進行在線的接口測試,并且提供Mock接口給前端進行對接,后續(xù)通過完善的文檔版本管理以及團隊協(xié)作功能,不斷地對項目進行迭代,提高項目整體的開發(fā)效率!
主要功能
- 快速全面地管理接口文檔 :1.UI可視化文檔,2. 支持表單、RESTful、Raw等設(shè)計規(guī)范,3. 通過注釋生成文檔,4. 版本管理,5. 支持富文本/Markdown,6. 分組管理,7. 星標(biāo)標(biāo)注。
- 測試接口是否正常運作:1. 支持在線、本地(localhost)測試,2. 支持跨域測試,3. 支持文件測試,4. 強大的參數(shù)構(gòu)造器。
- Mock API實現(xiàn)敏捷開發(fā):1. 根據(jù)文檔自動生成校驗數(shù)據(jù),2. 支持請求協(xié)議、請求方式校驗,3. 支持簡易Mock、高級Mock(Mockjs),4. 支持跨域調(diào)用。
- 了解團隊成員動向: 1. 團隊人員管理,,2. 支持設(shè)置人員讀寫權(quán)限,3. 支持成員昵稱,4. 支持通過鏈接邀請成員。
- 專業(yè)版:1. 強大的插件支持,2. 代碼生成,3. 測試用例,4. 空間日志,5. 高級權(quán)限管理,6. 5天 * 10小時 專業(yè)客戶成功部門一對一支持。
3、apizza
網(wǎng)址:http://apizza.cc/
極客專屬的api協(xié)作管理工具 免費的團隊協(xié)作,在線模擬調(diào)試,快速生成api文檔,導(dǎo)出離線版文檔
主要功能
- api跨域調(diào)試量身定制的chrome插件,本地,在線接口,都可以調(diào)。
- 免費的團隊協(xié)作 免費的團隊協(xié)作工具,極致的文檔編寫體驗,加快開發(fā)效率。
- 安全的云端存儲 安全可靠的云端存儲服務(wù),企業(yè)安全版支持本地數(shù)據(jù)中心。
- 一鍵分享 與團隊共享你的API文檔。
- 支持Postman,Swagger格式 導(dǎo)入Postman/Swagger json 生成文檔。
- 導(dǎo)出離線文檔 導(dǎo)出離線文檔,部署本地服務(wù)器。
- api Mock 根據(jù)文檔自動生成返回結(jié)果,提供獨立URL方便前端測試
- 支持多種文檔 http接口文檔,markdown說明文檔
4、RAML
網(wǎng)址:https://raml.org/
用 YAML 文件格式編寫,強大的官方支持,官方提供 atom 插件,支持語法智能提示及校驗,編寫快速簡單。
主要功能
- 支持 examples
- 支持 schema 校驗
- 支持工具測試
5、其他工具
1)、Swagger
網(wǎng)址:https://swagger.io/
通過固定格式的注釋生成文檔. 省時省力,不過有點學(xué)習(xí)成本。
2)、Showdoc
網(wǎng)址:https://www.showdoc.cc/
一個非常適合IT團隊的在線API文檔、技術(shù)文檔工具。
3)、apidoc
網(wǎng)址:http://apidocjs.com/
可以根據(jù)代碼注釋生成web api文檔,web接口的注釋維護起來更加方便,不需要額外再維護一份文檔。
4)、RAP:
網(wǎng)址:http://rap.taobao.org/org/index.do
一個可視化接口管理工具 通過分析接口結(jié)構(gòu),動態(tài)生成模擬數(shù)據(jù),校驗真實接口正確性, 圍繞接口定義,通過一系列自動化工具提升我們的協(xié)作效率。
5)、APIJSON:
網(wǎng)址:http://jsonapi.org/
客戶端可以定義任何JSON結(jié)構(gòu)去向服務(wù)端發(fā)起請求,服務(wù)端就會返回對應(yīng)結(jié)構(gòu)的JSON字符串,所求即所得。
總結(jié)
以上是生活随笔為你收集整理的echarts4离线使用文档_适合写API接口文档的管理工具有哪些?的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 刚做完鼻子注意事项是什么?
- 下一篇: 用-force –opengl 指令_O