文档章节

API文档编写工具

OpenIoT
 OpenIoT
发布于 2016/07/28 11:24
字数 403
阅读 932
收藏 16

从网络上检索到一些与API文档编写工具相关的资料,特记录如下:

  • APIDoc 一个简单的RESTful API文档生成工具,主要是对代码中的注释来生成文档。开源,http://apidoc.tools
  • prmd 根据JOSN样式来生成API文档的工具,开源, https://github.com/interagent/prmd
  • APIZza 将PostMan与API文档展现二合一,以SaaS形式提供使用,不开源, http://apizza.cc PS:感觉蛮方便的
  • EasyAPI 一个为您提供API管理、测试、监控、文档的综合平台,不开源,永久免费,提供一些有偿的增值服务 http://www.easyapi.com
  • APIManager PHP写的接口文档管理工具,开源,https://github.com/gongwalker/apimanager
  • Showdoc 一个非常适合IT团队或个人在线的API文档、技术文档工具 ,PHP编写,开源,https://github.com/star7th/showdoc
  • SosoAPI,API接口文档管理及测试平台,开源(?),http://www.sosoapi.com
  • DokuWiki ,这货我们一直在内部使用,不需要DB,能够跟踪文件内容的变化

简单了解后,准备将重点放在Showdoc、sosoapi上面,深入体验下能否满足内部使用。

各位看官,有没有更好的API文档工具推荐呢?

© 著作权归作者所有

共有 人打赏支持
OpenIoT

OpenIoT

粉丝 26
博文 17
码字总数 8227
作品 0
深圳
私信 提问
swagger入门和实践(含docker部署swagger)

简介 Swagger 是最流行的 API 开发工具,它遵循 OpenAPI Specification(OpenAPI 规范,也简称 OAS)。 Swagger 可以贯穿于整个 API 生态,如 API 的设计、编写 API 文档、测试和部署。 Swag...

数据架构师
09/23
0
0
Asp.Net Core 轻松学-利用 Swagger 自动生成接口文档

前言     目前市场上主流的开发模式,几乎清一色的前后端分离方式,作为服务端开发人员,我们有义务提供给各个客户端良好的开发文档,以方便对接,减少沟通时间,提高开发效率;对于开发...

Ron.liang
12/02
0
0
Dlib 18.1 发布,跨平台 C++ 通用库

Dlib 18.1 发布了,除了一些 bug 修复外,该版本还包含值得关注的改进: 更精确的 SURF 特征提取器 更快的切削平面解算器 对非常大的矩阵计算奇异值分解的程序 对大数据集进行相关分析的工具...

oschina
2013/03/27
1K
0
求好用的在线手册编写工具,能编写像bootstrap在线Doc那种的,想为OpenCenter写个在线手册

各位OSCer的开源项目的在线说明文档都是用什么写的呢? 类似 http://v3.bootcss.com/ Bootstrap的在线文档 这些开源项目的在线文档难道都是自己手写html的吗? word的话,代码高亮麻烦。 wi...

想天软件奕潇
2015/02/12
2K
4
微信退款接口

记录自己爬过的坑。 大家先感受一下来自微信官方的申请退款API文档带来的魅力。。。 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=94 下面是实现方法: 先贴出主方法,其中用到...

SquintSmile
02/01
2
0

没有更多内容

加载失败,请刷新页面

加载更多

eureka多注册中心

eureka分区的深入讲解

miaojiangmin
27分钟前
2
0
RAM SSO功能重磅发布 —— 满足客户使用企业本地账号登录阿里云

阿里云RAM (Resource Access Management)为客户提供身份与访问控制管理服务。使用RAM,可以轻松创建并管理您的用户(比如雇员、企业开发的应用程序),并控制用户对云资源的访问权限。 对云资...

阿里云官方博客
30分钟前
3
0
Mysql 8.0 | #08004Client does not support authentication protocol requested by server

完整报错 #08004Client does not support authentication protocol requested by server; consider upgrading MySQL client 解决方法 Using the old mysql_native_password works:ALTER ......

云迹
32分钟前
1
0
kylin入门到实战

1.概述 kylin是一款开源的分布式数据分析工具,基于hadoop之上的sql查询接口,能支持超大规模的数据分析。响应时间在亚秒级别,其核心是预计算,计算结果存放在hbase中。 2.特性 可扩展超快O...

hblt-j
35分钟前
1
0
vagrant mac 安装和使用

varant 在mac上使用起来非常的方便,具体的下载步骤可以看这里https://segmentfault.com/a/1190000000264347 这里主要是记录一下配置文件 # -*- mode: ruby -*- # vi: set ft=ruby : # All V...

一千零一夜个为什么
36分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部