文档章节

API文档编写工具

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

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

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

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

一刀
2017/06/25
1K
0
Dlib 18.1 发布,跨平台 C++ 通用库

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

oschina
2013/03/27
1K
0
Selenium的网友评论

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

红薯
2009/12/11
707
1
Eclipse用法:使用Javadoc导出项目的API文档

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

s360564346
2016/04/28
63
0
使用grunt-jsdoc自动化生成javascirpt文档

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

knightuniverse
2013/08/29
0
1

没有更多内容

加载失败,请刷新页面

加载更多

下一页

基于TP5的微信的公众号获取登录用户信息

之前讲过微信的公众号自动登录的菜单配置,这次记录一下在TP5项目中获取自动登录的用户信息并存到数据库的操作 基本的流程为:微信设置自动登录的菜单—>访问的URL指定的函数里获取用户信息—...

月夜中徘徊
57分钟前
0
0
youTrack

package jetbrains.teamsys.license.runtime; 计算lis package jetbrains.ring.license.reader; 验证lis 安装后先不要生成lis,要把相关文件进行替换 ring-license-checker-1.0.41.jar char......

max佩恩
今天
0
0
12.17 Nginx负载均衡

Nginx负载均衡 下面的dig看到可以返回2个IP,就是解析出来的IP,这样我们可以做负载均衡。 dig www.qq.com 1.vim /usr/local/nginx/conf/vhost/fuzai.conf 2.添加如下配置 upstream qq //定义...

芬野de博客
今天
0
0
SSE(Server Send Event 服务端发送事件)

package com.example.demo.controller;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframe......

Canaan_
今天
0
0
jvm调优

1.jvm运行模式 client模式:启动快,占用内存少,jit编译器生成代码的速度也更快. server模式:主要优势在于代码优化功能,这个功能对于服务器应用而言尤其重要. tiered server模式:结合了client与...

Funcy1122
今天
1
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部