我需要有SwaggerUI，暴露了我在KONG API网关上Map的路由。我不知道香港社区版本是否有swagger插件，它可以自动生成模式？我试图搜索，看看是否有任何插件availble出口招摇过市，但它似乎不支持。
w1jd8yoj1#
我完全理解为什么你想为你的Kong API Gateway提供一个漂亮的Swagger UI。拥有交互式文档可以让开发人员更容易理解和测试你的API。好消息是，虽然Kong没有内置的Swagger UI，但您实际上可以通过一些工作来创建自己的UI。具体来说，Kong的`/routes端点返回所有已配置路由的列表。每个路由都包含所连接服务的ID。然后，您可以获取这些服务ID并向/services/发出请求，以获取有关每个服务的更多信息，例如它代理的URL。因此，完整的工作流程将是：
/routes
/services/<service-id>
关键是Kong的Admin API。这让你可以提取关于你的API、路由、服务等的所有细节。因此，您可以使用它来获取生成Swagger规范所需的数据-基本上是一个描述API端点的JSON文件。一旦您有了规范，您就可以将其插入Swagger UI，这是一个开源工具，可以将这些规范转换为非常好看的文档。你只需要在一个基本的Web服务器上托管Swagger UI。当一个开发者加载你的SwaggerUI站点时，它将读取该规范并自动生成交互式文档。
1条答案
按热度按时间w1jd8yoj1#
我完全理解为什么你想为你的Kong API Gateway提供一个漂亮的Swagger UI。拥有交互式文档可以让开发人员更容易理解和测试你的API。
好消息是，虽然Kong没有内置的Swagger UI，但您实际上可以通过一些工作来创建自己的UI。
具体来说，Kong的`/routes端点返回所有已配置路由的列表。每个路由都包含所连接服务的ID。
然后，您可以获取这些服务ID并向/services/发出请求，以获取有关每个服务的更多信息，例如它代理的URL。
因此，完整的工作流程将是：
/routes获取所有路由/services/<service-id>关键是Kong的Admin API。这让你可以提取关于你的API、路由、服务等的所有细节。因此，您可以使用它来获取生成Swagger规范所需的数据-基本上是一个描述API端点的JSON文件。
一旦您有了规范，您就可以将其插入Swagger UI，这是一个开源工具，可以将这些规范转换为非常好看的文档。你只需要在一个基本的Web服务器上托管Swagger UI。
当一个开发者加载你的SwaggerUI站点时，它将读取该规范并自动生成交互式文档。