API文档编写工具
博客专区 > OpenIoT 的博客 > 博客详情
API文档编写工具
OpenIoT 发表于1年前
API文档编写工具
  • 发表于 1年前
  • 阅读 380
  • 收藏 10
  • 点赞 0
  • 评论 0

标题:腾讯云 新注册用户域名抢购1元起>>>   

摘要: 项目开发过程中,经常需要写大量的API,提供给外部去调用,除了代码实现,文档的约定变得非常重要。传统方法通过word、pdf等文件方式传递,存在很大缺点。目前我们是在内部搭建wiki(dokuwiki)的方式,来展现API文档内容,但也存在一些小问题,感觉不方便。

从网络上检索到一些与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文档工具推荐呢?

标签: api wiki
共有 人打赏支持
OpenIoT
粉丝 23
博文 16
码字总数 7856
×
OpenIoT
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: