是否有任何工具可以从 JSON 或 Open API 自动创建类似 wiki 的 REST API 文档?
Is there any tool to automatically create wiki-like REST API documentation from JSON or Open API?
我有几项服务,每一项都通过 REST API 和 ASP.NET 核心 Web API 公开。我使用 Swashbuckle for ASP.NET Core 工具,以便从我的控制器和 DTO 自动生成所有必要的文档,并在 SwaggerUI 中将其可视化。我发现这个工具真的很棒,我的模型上几乎没有注释,我的控制器已经提供了许多开箱即用的功能,例如 UI 客户端来试用 REST API 端点。
但是有了这个解决方案,每个服务都有自己专用的 SwaggerUI 实例,因此 UI。
我想为我的客户提供一个带有导航菜单的类似 wiki 的文档,例如,他们可以在其中浏览有关我的服务公开的所有端点的部分,并在每个页面上具有 Swagger[=25= 提供的相同功能].
这可以通过创建我自己的 Web 应用程序来实现,但我想知道是否已经存在开箱即用的解决方案或一些可以简化此类集成的工具。
我尝试了 Slate 但我觉得我必须重新发明轮子才能至少自动创建基本 API 文档,即控制器定义、响应定义和描述。有人有什么建议吗?
我最近在微服务架构中遇到了这个问题,你说得对。不需要重新发明轮子。
在这种情况下,我真的不能推荐 redoc by Redocly。
我有几项服务,每一项都通过 REST API 和 ASP.NET 核心 Web API 公开。我使用 Swashbuckle for ASP.NET Core 工具,以便从我的控制器和 DTO 自动生成所有必要的文档,并在 SwaggerUI 中将其可视化。我发现这个工具真的很棒,我的模型上几乎没有注释,我的控制器已经提供了许多开箱即用的功能,例如 UI 客户端来试用 REST API 端点。
但是有了这个解决方案,每个服务都有自己专用的 SwaggerUI 实例,因此 UI。
我想为我的客户提供一个带有导航菜单的类似 wiki 的文档,例如,他们可以在其中浏览有关我的服务公开的所有端点的部分,并在每个页面上具有 Swagger[=25= 提供的相同功能].
这可以通过创建我自己的 Web 应用程序来实现,但我想知道是否已经存在开箱即用的解决方案或一些可以简化此类集成的工具。 我尝试了 Slate 但我觉得我必须重新发明轮子才能至少自动创建基本 API 文档,即控制器定义、响应定义和描述。有人有什么建议吗?
我最近在微服务架构中遇到了这个问题,你说得对。不需要重新发明轮子。
在这种情况下,我真的不能推荐 redoc by Redocly。