如何生成RestFul Api文档详解编程语言
2023-06-13 09:20:35 时间
Web API文档工具列表
Swagger ——Swagger框架可以通过代码生成漂亮的在线API,甚至可以提供运行示例。支持Scala、Java、Javascript、Ruby、PHP甚至 Actionscript 3。在线 Demo 。
I/O Docs ——I/O Docs是一个用于RESTful Web APIs的交互式文档系统。使用 JSON 模型根据资源、方法和参数定义 APIs。I/O Docs 将生成 JavaScript 客户端接口,可通过这些接口来调用系统。服务器端基于 Node.js 开发。在线Demo
apiary.io ——能够快速启动和运行文档,包括GitHub集成和I/O验证——更多建议可以前往Reddit查看上关于 Siyfion讨论。
Docco ——Docco是一个快速而随意、hundred-line-long、迭代程序风格的文档生成器。它会以HTML的方式显示评论和代码。
Dexy ——非常灵活的一款文档工具,支持任何语言编写的API。
Doxygen ——Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。 更多建议可以前往Reddi上查看 gkumar007相关讨论。
TurnAPI ——是一款付费的文档API工具。里面包含了智能WIKI编辑器、基于标准的Markdown、文档分支、还可以与Git、SVN、Mercurial同步、整洁的主题、友好的界面。
以上仅是作者在实践中发现的一些很好的工具,如果你有更好的建议或工具推荐,欢迎与我们分享。
aglio工具—— danielgtaylor/aglio · GitHub 用 markdown 格式编写文档, 用 aglio生成 文档页面, 美观, 简单, 可定制
相关文章
- webapi文档描述-swagger
- XX高校校园网网络规划与设计_职业生涯规划word文档
- kubesphere安装文档
- 数据产品需求文档自查清单
- 英语不好,对 SAP 英文文档有所畏惧,该怎么办?
- BeautifulSoup文档3-详细方法 | 如何对文档树进行遍历?
- “注释”生成“VitePress文档网站”只需要“一行命令”!来试试!
- 超简单!Java 项目自动生成接口文档教程
- Oracle官方文档库:必看资料(oracle官方文档库)
- Linux文档工具:快速帮助您解决问题(linux文档工具)
- Linux下PHP文档指南(linuxphpdoc)
- 实现oracle云端系统的步骤指南(oracle云的实施文档)
- Oracle Docx文档数据库学习必备之选(oracle docx)
- C#写入XML文档三种方法详细介绍