文档章节

API文档编写工具

OpenIoT
 OpenIoT
发布于 2016/07/28 11:24
字数 403
阅读 590
收藏 14
点赞 0
评论 0

从网络上检索到一些与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

粉丝 24
博文 17
码字总数 8227
作品 0
深圳
RESTful API 文档生成工具--API-doc

RESTful API 标准文档生成工具,可生成直观的HTML形式、PDF格式的文档,方便API开发者查阅。 1. 遵循OpenAPI规范编写RESTful API的接口定义 2. 生成直观的HTML和PDF格式的文档 3. 对中文的完...

一刀 ⋅ 2017/06/25 ⋅ 0

Dlib 18.1 发布,跨平台 C++ 通用库

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

oschina ⋅ 2013/03/27 ⋅ 0

使用grunt-jsdoc自动化生成javascirpt文档

背景 Javascript已经成为一门被人们重新认识的编程语言,由于大量JS开源框架的出现,利用Javascript开发的项目越来越多,越来越大。同时,也有越来越多Javascript开发问题暴露出来,如性能、...

knightuniverse ⋅ 2013/08/29 ⋅ 1

Selenium的网友评论

Selenium 是 thoughtworks公司的一个集成测试的强大工具。最近参与了一个系统移植的项目,正好用到这个工具,把一些使用心得分享给大家,希望大家能多多使 用这样的强大的,免费的工具,来保证...

红薯 ⋅ 2009/12/11 ⋅ 1

Eclipse用法:使用Javadoc导出项目的API文档

eclipse直接自动生成整个项目的API帮助文档的小tips 另外,eclipse加入doc注释的快捷键:Shift+Alt+J 本文将具体讲述使用Eclipse开发工具导出项目的Javadoc文档的步骤和常见的问题。 技术文档...

s360564346 ⋅ 2016/04/28 ⋅ 0

php开发工具

1 设计工具 2 编码工具 3 测试工具 4 部署工具 5 管理工具 设计工具 UML和相关设计工具 Argo UML UML绘图工具,支持PHP stub生成。-–Java编写。 Umbrello UML UML绘图工具,支持PHP stub生成...

“寒流” ⋅ 2011/04/26 ⋅ 2

微信退款接口

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

SquintSmile ⋅ 02/01 ⋅ 0

求好用的在线手册编写工具,能编写像bootstrap在线Doc那种的,想为OpenCenter写个在线手册

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

陈一枭 ⋅ 2015/02/12 ⋅ 4

敏捷开发需要编写文档吗

在产品研发过程中经常需要编写很多文档,例如:需求文档、设计文档、API文档、验收文档等等。团队成员要花费很多精力去维护众多的文档,甚至有“兄弟,我替你写代码,你替我写文档”的无奈。...

一等兵 ⋅ 2016/03/22 ⋅ 0

liushoukun/restfulapi-tp5

Dawn-Api [Toc] 说明 thinkphp5编写的restful风格的API,集API请求处理,权限认证,自动生成文档等功能; restful风格处理请求 每个接口对于一个控制器,method对应[method]方法响应 权限认证...

liushoukun ⋅ 2017/02/21 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

对于程序员的招聘问题,作为软件人的一些吐槽和建议

作为软件人,找工作有时候似乎挺苦逼的。 说真的,让我去掉前面这句中“似乎”二字吧。就是苦逼!很多人都曾抱怨处在招聘的一方很糟糕——我们没有任何可靠的方式来甄别会写代码并且写得好的...

老道士 ⋅ 19分钟前 ⋅ 0

HDFS原理学习

一、概述 1、 Hadoop整合了众多的文件系统,首先提供了一个高层的文件系统抽象org.apache.hadoop.fs.FileSystem。然后有各个文件系统的实现类。 2、Hadoop是JAVA编写的,不同文件系统之间的交...

cjxcloud ⋅ 23分钟前 ⋅ 0

Linux下MySQL表名不区分大小写的设置方法(抄袭别人的)

Linux下MySQL表名不区分大小写的设置方法 MySQL表名不区分大小写的设置方法 在用centox安装mysql后,把项目的数据库移植了过去,发现一些表的数据查不到,排查了一下问题,最后发现是表名的大...

随风而浮沉 ⋅ 28分钟前 ⋅ 0

ubuntu下安装宋体simsun

sudo cp simsun.ttc /usr/share/fonts cd /usr/share/fonts sudo chmod 644 simsun.ttc 更新字体缓存: 代码: sudo mkfontscale 代码: sudo mkfontdir 代码: sudo fc-cache -fsv 安装chrome扩......

wangxuwei ⋅ 29分钟前 ⋅ 0

利用 ssh 传输文件

Linux 下一般可以用 scp 命令通过 ssh 传送文件: #把服务器上的 /home/user/a.txt 发送到本机的 /var/www/local_dir 目录下scp username@servername:/home/user/a.txt /var/www/local_dir...

大灰狼时间 ⋅ 39分钟前 ⋅ 0

web3j教程:android和java程序员如何使用web3j开发区块链以太坊

如何使用web3j为Java应用或Android App增加以太坊区块链支持,本教程内容即涉及以太坊中的核心概念,例如账户管理包括账户的创建、钱包创建、交易转账,交易与状态、智能合约开发与交互、过滤...

智能合约 ⋅ 今天 ⋅ 0

web3j开发java或android以太坊智能合约快速入门

web3j简介 web3j是一个轻量级、高度模块化、响应式、类型安全的Java和Android类库提供丰富API,用于处理以太坊智能合约及与以太坊网络上的客户端(节点)进行集成。 可以通过它进行以太坊区块链...

笔阁 ⋅ 今天 ⋅ 0

一起读书《深入浅出nodejs》-异步I/O

异步I/O “异步”这个名词其实很早就诞生了,但它大规模流行却是在Web 2.0浪潮中,它伴随着AJAX的第一个A(Asynchronous)席卷了Web。 为什么要异步I/O 关于异步I/O为何在Node里如此重要,这与...

小草先森 ⋅ 今天 ⋅ 0

JVM各种问题

1、如果启动什么都不设,会怎样? 先来看一个命令 [root@localhost bin]# java -XX:+PrintCommandLineFlags -version -XX:InitialHeapSize=29899008 -XX:MaxHeapSize=478384128 -XX:+PrintCo......

算法之名 ⋅ 今天 ⋅ 0

SAS笔记-宏2

宏是一种文本,一般来说其编译是在程序执行之前。 宏变量的创建 %let语句 %let macro_variables = text; %let是常见的宏变量建立方式,其编译就在执行前。如下例中,想要宏变量test等于数据集...

tonorth123 ⋅ 今天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部