为 Datasnap RESTful API 生成文档

【问题标题】：Generating documentation for a Datasnap RESTful API为 Datasnap RESTful API 生成文档
【发布时间】：2015-12-01 08:58:40
【问题描述】：

我一直在寻找一种将自动生成的文档端点包含到现有 Delphi Datasnap RESTful API 的方法。

可以吗？我可以使用注释或外部工具吗？我从哪里开始，我将如何进行？如果不是来自 Delphi 本身，我可以与例如集成吗？大摇大摆？

如今在不提供文档端点的情况下构建 RESTful API 似乎有些不合时宜...

非常感谢任何可以帮助我朝着正确方向发展的信息。

【问题讨论】：

【解决方案1】：

使用 Swagger，通过 YAML 刚刚通过 EMS 添加到 Delphi，这是 Delphi 中最新的 RESTful API 开发选项。

它基于在定义时添加到 API 端点的属性，进而创建要导入 Swagger 的 YAML。

【讨论】：

我最终编写并使用了一个源文件解析器，该解析器从源代码和 XML 注释块生成 YAML 或 JSON，效果非常好。很高兴看到这最终以不需要 DIY 的官方形式存在。感谢您的链接！