首页 > 解决方案 > 有没有一种简单的方法可以从 express-gateway 服务生成 API 文档?

问题描述

有没有一种简单的方法可以从 express-gateway 服务生成 API 文档?例如使用招摇?在传统方式中,文档是基于函数的注释生成的,在 express-gateway APIS 中定义在 gateway.config.yml 文件中,并且 swagger 不知道如何处理它。

标签: node.jsswaggerdocumentationswagger-uiexpress-gateway

解决方案


目前这是不可能的。文档需要的信息比 Express Gateway yaml 文件中的信息要丰富得多,并且描述 EG 文件的模式不允许提供其他信息。

理想情况下,会有一个工具可以处理 Swagger/OpenAPI 规范并创建 Express Gateway 配置文件,但我还没有找到。


推荐阅读