documentation - 从 Tornado Web 服务器代码生成交互式 API 文档

Question

我有一个 Tornado Web 服务器，它在其 API 中公开了一些端点。
我希望能够在代码中记录我的处理程序(端点)，包括描述、参数、示例、响应结构等，然后生成一个 互动 文档使人们能够“玩”我的 API，轻松地提出请求并在沙箱环境中体验响应。

我知道 Swagger ，尤其是他们的 SwaggerUI 解决方案是最好的工具之一，但我对它的工作原理感到困惑。我知道我需要为 SwaggerUI 引擎提供一些 .yaml它定义了我的 API，但如何从我的代码中生成它？
我发现很多 github 库不够好或者只支持 Flask ......

谢谢

Answer 1

据我了解，SwaggerUI 依赖于 swagger 规范。
因此，它归结为以简洁优雅的方式生成 Swagger 规范。
你有机会看看apispec ?
我发现这是一个带有 Tornado 插件的活跃项目。