阿里云服务器2核4G 3年仅847元(点击查看)

开源的api文档管理系统汇总

83次阅读
没有评论

开源的api文档管理系统汇总

在项目中,需要协同开发,所以会写许多API文档给其他同事,以前都是写一个简单的TXT文本或Word文档,口口相传,这种方式比较老土了,所以,需要有个api管理系统专门来管理这些api,从网上找了许多比较好的开源文档管理系统,可以应用到项目中。

支持私有化部署

gitbook

docsify

vuepress

RAP2

RAP代码地址: https://github.com/thx/RAP

RAP2代码地址: https://github.com/thx/rap2-delos

showdoc

国内的Showdoc
国内开源的非常好用的一款API文档管理系统,安装也非常方便,只需将源代码放到项目目录下自动安装运行即可,不要要注意PHP版本必须大于5.3.

开源的api文档管理系统汇总

easyopen

代码: https://gitee.com/durcframework/easyopen

开源文档汇总

swagger-ui

1、国外的话Swagger

swagger-ui: http://swagger.io/

postMan

5、postMan

eoLinker

3、界面简洁功能强大的eoapi

现在改名为:eoLinker
业内领先的 API 全生命周期管理解决方案

DOClever

官网地址: https://github.com/sx1989827/DOClever
文档手册: https://www.kancloud.cn/lovefeiyang/doclever/432894
DOClever是一款开源免费的可视化接口管理工具,专业的api接口管理系统,集接口文档、接口自动化测试、Mock数据、团队协作、接口快照等于一身的移动时代首选接口管理平台!

DOClever 是一个商业化开源产品,完全免费。无论你是前端工程师,还是后端工程师,接口永远都是两者交互的桥梁,所以DOClever专为中小型团队量身打造,旨在解决接口的管理,测试与数据生成,实现真正的一体化解决方案。

docute

6、docute: 无需编译的文档撰写工具

docute 的文档: https://docute.js.org/#/zh-Hans/ (基于 Vue)

Github 项目:https://github.com/egoist/docute

SmartWiki

7、SmartWiki 接口文档在线管理系统

SosoApi

8、SosoApi
SosoApi,编辑Swagger UI的神器

CrapApi

9、CrapApi开源接口管理系统演示地址

CrapApi:一个由angularjs+bootstrap+springMVC搭建的高性能的免费开源的API接口、文档管理系统(应用接口管理系统)

GitHub源码地址:https://github.com/EhsanTang/…
码云源码地址:http://git.oschina.net/CrapAp…

站点使用地址:http://api2.crap.cn

TeaKKi

10、 TeaKKi
这个WIKI用来写文档也不错~
TeaKKi team wiki, https://teakki.com 超越了wiki, 在wiki基础上支持团队知识协作

apidoc

11、Web API文档生成工具apidoc

这个需要在编辑后生成静态的HTML页面,然后上传到服务器。

工具名称:apiDoc
Git地址:https://github.com/apidoc/apidoc
项目地址:http://apidocjs.com/
样例项目:http://apidocjs.com/example_b…
apoDoc是从源码的注释中生成RestFul api 文档,样子还是蛮漂亮的……

使用apidoc 生成Restful web Api文档
NodeJS、NPM安装配置步骤(windows版本)

Apidoc安装与使用

PHP_DOC

12、PHP_DOC 实时生成 API 文档
https://segmentfault.com/a/11…

Outline

13、Outline
GitHub地址:https://github.com/authing/ou…

这个开源的文档界面看起来还挺不错。

community

14、documize/community
GitHub地址:https://github.com/documize/c…

线上文档

语雀

①、阿里的 语雀

乐享

②、腾讯的 乐享

confluence

③、confluence

https://ones.ai/products/wiki.html

相关文章:
《移动开发接口及文档编写规范》V1.0

arison
版权声明:本站原创文章,由arison2021-01-05发表,共计5818字。
转载提示:除特殊说明外本站文章皆由CC-4.0协议发布,转载请注明出处。
评论(没有评论)