开源的api文档管理系统
请打开链接查看https://segmentfault.com/a/1190000007704665https://www.cnblogs.com/calamus/p/8340769.html来自segmentfault.com以下 来自 https://segmentfault.com/a/1190000007704665最好打开链接看在项目中,需要协同开发,所以会写许多API文档...
请打开链接查看
https://segmentfault.com/a/1190000007704665
https://www.cnblogs.com/calamus/p/8340769.html
来自segmentfault.com
以下 来自 https://segmentfault.com/a/1190000007704665 最好打开链接看
在项目中,需要协同开发,所以会写许多API文档给其他同事,以前都是写一个简单的TXT文本或Word文档,口口相传,这种方式比较老土了,所以,需要有个api管理系统专门来管理这些api,从网上找了许多比较好的开源文档管理系统,可以应用到项目中。
1、国外的话Swagger
swagger-ui
2、国内的Showdoc
国内开源的非常好用的一款API文档管理系统,安装也非常方便,只需将源代码放到项目目录下自动安装运行即可,不要要注意PHP版本必须大于5.3.
clipboard.png
3、界面简洁功能强大的EOAPI
4、阿里的RAP
Web API management, free and open sourced, mock data generator, auto test, made by Alibaba, using by 1000+ corporations! Web接口管理工具,开源免费,接口自动化,MOCK数据自动生成,自动化测试,企业级管理。阿里妈妈MUX团队出品!阿里巴巴都在用!1000+公司的选择!一直被抄袭,从未被超越 :3 http://rapapi.net
5、postMan
6、docute: 无需编译的文档撰写工具
像 gitbook 之类的工具需要编译后发布,而 docute 让你直接写 markdown 文件作为文档来显示而不需要编译成 html 这一步,你的文档目录里只需要一个首页 index.html 和你的配置文件 config.js。
docute 会直接渲染这些 markdown 文件为一个单页应用。配合 github pages 发布到 ./docs 目录效果更佳,当然发布到任何地方都可以。
docute 的文档: https://docute.js.org/#/zh-Hans/ (基于 Vue)
Github 项目:https://github.com/egoist/docute
7、SmartWiki 接口文档在线管理系统
clipboard.png
clipboard.png
clipboard.png
clipboard.png
8、SosoApi
SosoApi,编辑Swagger UI的神器
clipboard.png
9、CrapApi开源接口管理系统演示地址
CrapApi:一个由angularjs+bootstrap+springMVC搭建的高性能的免费开源的API接口、文档管理系统(应用接口管理系统)
GitHub源码地址:https://github.com/EhsanTang/…
码云源码地址:http://git.oschina.net/CrapAp…
主要功能:api接口管理、数据字典管理、接口数据模拟、接口文档管理(支持markdown、kindereditor等编辑器)、支持本地部署或在线使用、支持通过建表语句导入数据字典…
其他功能:项目管理、用户管理、模块管理、接口管理、接口版本管理、接口拷贝、接口文档pdf下载、接口mock、模块加密访问、
接口在线调试、数据字典管理、数据字典加密访问多管理员、多权限、多角色管理、自定义菜单、自定义网站样式、文档留言、
错误码管理、接口排序、DOC、PDF、TEXT、EXCEL等资源管理、支持版本号控制、文档内容检索、操作日志记录、
根据日志恢复数据、markdown编辑器、kindeditor编辑器、angularjs编辑器、Lucene搜索、项目成员管理…
站点使用地址:http://api2.crap.cn
效果图:
clipboard.png
clipboard.png
10、 TeaKKi
这个WIKI用来写文档也不错~
TeaKKi == team wiki, https://teakki.com 超越了wiki, 在wiki基础上支持团队知识协作
clipboard.png
11、Web API文档生成工具apidoc
这个需要在编辑后生成静态的HTML页面,然后上传到服务器。
工具名称:apiDoc
Git地址:https://github.com/apidoc/apidoc
项目地址:http://apidocjs.com/
样例项目:http://apidocjs.com/example_b…
apoDoc是从源码的注释中生成RestFul api 文档,样子还是蛮漂亮的……
- DOClever
DOClever是一个可视化接口管理工具,可以分析接口结构,校验接口正确性, 围绕接口定义文档,通过一系列自动化工具提升我们的协作效率。DOClever前后端全部采用了javascript来作为开发语言,前端用的是vue+element UI,后端是express+mongodb,这样的框架集成了高并发,迭代快的特点,保证系统的稳定可靠
官网: http://doclever.cn
Github: https://github.com/sx1989827/DOClever
码云: https://git.oschina.net/sx1989827/SBDoc
更多推荐
所有评论(0)