从模式生成静态API文档?

问题描述 投票:0回答:2

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

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

其他操作系统项目是否有提供此功能的模块?

node.js express swagger swagger-ui koa
2个回答
1
投票

鉴于您拥有 OpenAPI/Swagger 规范,您可以访问 https://editor.swagger.io 来尝试 Swagger Codegen。在“生成客户端”下选择“HTML”或“动态 HTML”

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

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


0
投票

对于最近发现此问题的人,这里是您可以使用的工具。它称为 TSOA:https://tsoa-community.github.io/docs/

© www.soinside.com 2019 - 2024. All rights reserved.