是否有任何工具可以从JSON或Open API自动创建类似维基的REST API文档



我有几个服务,每个服务都通过带有ASP.NET Core Web API的REST API公开。我使用Swashbuckle for ASP.NET Core工具,以便从我的控制器和DTO自动生成所有必要的文档,并在SwaggerUI中可视化它。我发现这个工具非常棒,在我的模型和控制器上只添加了一些注释,就已经提供了许多现成的功能,比如一个UI客户端来尝试RESTneneneba API端点
但使用此解决方案,每个服务都有自己的专用SwaggerUI实例,因此也有UI。我想为我的客户提供一个类似维基的文档,带有导航菜单,例如,他们可以在其中浏览有关我的服务公开的所有端点的部分,并且在每个页面上都有SwaggerUI提供的相同功能。

这可以通过创建自己的web应用程序来实现,但我想知道是否已经存在现成的解决方案或一些可以简化这种集成的工具。我尝试了Slate,但我觉得我必须重新安装轮子,以便至少自动创建基本的API文档,即控制器定义、响应定义和描述。有人有什么建议吗?

我最近在微服务架构中工作时遇到了这个问题,你说得对。没有必要重新发明轮子。

在这种情况下,我真的不能推荐Redocly的redoc。

看看多个api的例子。

最新更新