1、国外的话Swagger
swagger-ui
2、国内的Showdoc
国内开源的非常好用的一款API文档打点系统,安置也非常便利,只需将源代码放到项目目录下自动安置运行即可,不要要注意PHP版本必需大于5.3.
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
5、postMan
6、docute: 无需编译的文档撰写工具
像 gitbook 之类的工具需要编译后颁布,而 docute 让你直接写 markdown 文件作为文档来显示而不需要编译成 html 这一步,你的文档目录里只需要一个首页 index.html 和你的配置文件 config.js。
docute 会直接衬着这些 markdown 文件为一个单页应用。共同 github pages 颁布到 ./docs 目录效果更佳,固然颁布到任何处所都可以。
docute 的文档: (基于 Vue)
Github 项目:https://github.com/egoist/docute
7、SmartWiki 接口文档在线打点系统
8、SosoApi
SosoApi,编纂Swagger UI的神器
9、
CrapApi:一个由angularjs+bootstrap+springMVC搭建的高性能的免费开源的API接口、文档打点系统(应用接口打点系统)
GitHub源码地点:https://github.com/EhsanTang/...
码云源码地点:
主要成果:api接口打点、数据字典打点、接口数据模拟、接口文档打点(撑持markdown、kindereditor等编纂器)、撑持本地部署或在线使用、撑持通过建表语句导入数据字典...
其他成果:项目打点、用户打点、模块打点、接口打点、接口版本打点、接口拷贝、接口文档pdf下载、接口mock、模块加密访谒、
接口在线调试、数据字典打点、数据字典加密访谒多打点员、多权限、多角色打点、自界说菜单、自界说网站样式、文档留言、
错误码打点、接口排序、DOC、PDF、TEXT、EXCEL等资源打点、撑持版本号控制、文档内容检索、操纵日志记录、
按照日志恢复数据、markdown编纂器、kindeditor编纂器、angularjs编纂器、Lucene搜索、项目成员打点...
站点使用地点:
效果图:
10、 TeaKKi
这个WIKI用来写文档也不错~
TeaKKi == team wiki, https://teakki.com 逾越了wiki, 在wiki根本上撑持团队常识协作
11、Web API文档生成工具apidoc
这个需要在编纂后生成静态的HTML页面,然后上传随处事器。
工具名称:apiDoc
Git地点:https://github.com/apidoc/apidoc
项目地点:
样例项目:
apoDoc是从源码的注释中生成RestFul api 文档,样子还是蛮标致的……
使用apidoc 生成Restful web Api文档
NodeJS、NPM安置配置法式(windows版本)
Apidoc安置与使用
具体法式:Windows安置要领:
1、官网nodejs.org下载Node
2、安置
3、将npm 替换为淘宝镜像cnpm
C:\Users\Administrator>npm install -g cnpm --registry=https://registry.npm.taobao.org4、使用cnpm安置apidoc
C:\Users\Administrator>cnpm install apidoc -g