java - 针对非标准 Java 技术的 Swagger API 集成

Question

我们有一个使用 http POST 和 JSON 作为 RPC 方法的系统。它是用于内部组件通信的内部解决方案。

请求和响应均由 Java bean (POJO) 描述。

我的问题是，如何使用 swagger 注释在 swagger 标准中创建漂亮的文档？

我并不害怕搞乱现有的代码，但我想知道是否有人有类似的经验。

目标是使用 Swagger UI 来显示漂亮的文档，并为用户调用 API 提供一个平台。

Answer 1

根据上面的评论，不可能使用 Swagger 来描述此类 API。 Swagger 规范旨在基于 REST 的 API，其中 URL 充当描述操作的唯一端点，而不是有效负载。

根据定义，Swagger 认为唯一的操作是 URL 和 HTTP 方法的组合(例如，有人请求扩展定义以包括 mime 类型，但目前不可用)。

根本无法描述操作多个请求类型的单个端点，每个请求类型都有自己的输出。

将来可能可以满足您的要求，但不是在不久的将来，也不会完全满足您的要求。

需要明确的是 - 这不是乱搞代码或任何东西的问题。规范本身不支持。