<分区>
我正在使用 aglio 生成我的 API 文档。我目前正在根据 API 蓝图规范为此编写原始 Markdown 。我想知道是否有一种方法可以直接在代码中通过注释生成 Markdown 。有人知道这样做的方法吗？
<分区>
我正在使用 aglio 生成我的 API 文档。我目前正在根据 API 蓝图规范为此编写原始 Markdown 。我想知道是否有一种方法可以直接在代码中通过注释生成 Markdown 。有人知道这样做的方法吗？
最佳答案
从技术上讲这是可能的。取决于您的语言和使用的框架。例如，在 Ruby 中，可以使用 RSpec to generate API Blueprint .
我不熟悉任何为 Node.js 做类似事情的工具(例如使用 Express.js DSL)。
在编写生成蓝图的工具时，可以避免手动编写蓝图并使用 Matter Compiler反而。此工具 (Ruby gem) 将 JSON 或内存树 (AST) 转换为 API 蓝图。
请注意，我个人建议不要从代码生成文档。相反，我将 API 蓝图视为可用于 test your API implementation 的合约。 .
从这个意义上说，从代码生成蓝图就像从代码生成测试(测试完全相同的代码)。
关于node.js - 通过代码注释生成 API 文档，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/23662910/
相关文章：
documentation - 网络开发 : How to write a website specification doc?
node.js - ionic+firebase+elasticsearch 无法使用 elasticsearch.js 进行身份验证
node.js - Node : extend EventEmitter to non-prototype object
node.js - Nodejs : managing distributed transactions like java ee
python - 使用带有 graphql 查询的 API 在 R 上抛出 401 错误，但在 Python 上工作正常
rest - ColdFusion REST API 启用 CORS