从架构生成静态API文档?

时间:2016-05-03 12:08:38

标签: node.js express swagger swagger-ui koa

我有Koa / Express应用程序,并希望根据不同API路径的注释生成静态文档。

Swagger似乎很好,但是我发现的所有软件包都不会生成文档,而是使用API​​本身托管它。 我希望API文档与我的API分开。

是否有其他OS项目的模块提供此功能?

1 个答案:

答案 0 :(得分:1)

鉴于您已获得OpenAPI / Swagger规范,您可以转到Swagger Codegen尝试https://editor.swagger.io。在“生成客户端”下,选择“HTML”或“动态HTML”

或者您可以使用https://restunited.com生成包含代码示例的SDK和文档。以下是一个示例:http://restunited.com/docs/6y2jvtvkgvst

披露:我是Swagger Codegen的最大贡献者和RESTUnited.com的创始人