node.js - 如何生成api文档

标签 node.js documentation twitter-bootstrap documentation-generation

我需要为我创建的 REST API 编写一些 api 文档。是否有工具可以生成类似于下划线 api 文档的漂亮 html 输出?或者可能会输出一些东西作为 twitter bootstrap 样式的 html?

我看到 docco 做了带注释的代码,但我实际上只是想记录 API。理想情况下,我想将一个工具指向 Controller 文件并让它生成有关方法和路由的文档,但不显示任何源代码,除非我专门调用示例。

最佳答案

apiDoc从源代码中的 API 注释创建文档。

Integrated 是 API 历史记录,可以比较各种 API 版本级别。 因此可以追溯自上一个版本以来 API 中的变化。

演示:http://apidocjs.com/example

Github:https://github.com/apidoc/apidoc

关于node.js - 如何生成api文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/11969542/

相关文章:

c# - 如何为 C# 生成输出为 Azure DevOps Wiki 的 Markdown 的文档?

html - 将中心 div 推到移动设备上的内容顶部

python - 在 Django 1.9 中更改站点名称

documentation - 有人知道比较不同 Scheme 实现的好文档吗?

ios - 为什么我应该在 main 中为串行队列创建上下文并在 start 中为并发队列创建上下文?

angularjs - 带有 Bootstrap 4 的 Angular UI 模式

node.js - 如何调试nodejs项目?

node.js - Sequelize 查询以查找落在日期范围和时间范围之间的所有记录

javascript - Mongoose $slice 并获取原始大小的数组

node.js - Async/Await 然后在我的情况下不起作用