我正在寻找使用 Node 和 Express 构建 REST API,并且我想提供文档。我不想手工制作这个,似乎有 Swagger、RAML 和 Api Blueprint/Apiary 形式的解决方案。
我真正想要的是让文档从 API 代码自动生成,这在 .NET 领域中使用 Swashbuckle 或 Microsoft 提供的解决方案是可能的,但它们是通过强类型和反射实现的。
对于 JS 世界,似乎正确的选择是使用 Swagger/RAML/Api 蓝图标记来定义 API,然后生成文档并从中构建服务器。前者看起来很简单,但我对后者不太确定。我所看到的所有这些选项的服务器代码生成似乎非常有限。需要某种方法将自动生成的代码与手动代码分开,以便可以轻松更新定义,我没有看到任何迹象或讨论。这似乎不是一个无法克服的问题(我对 .NET 比对 JS 更熟悉,所以我很容易遗漏一些东西),并且在上一个Stack Overflow 问题中提到了这个问题和解决方案。一年前。
谁能告诉我我是否遗漏/误解了任何内容以及是否存在上述问题的任何解决方案?