问题标签 [swagger]

我正在寻找一种方法来记录我的 Rest API。我的服务器是 Tomcat/Spring 服务器，其余 API 是使用 Jenkins 实现的。

Swagger 似乎是一个非常酷的解决方案，但我不知道如何将它与我的代码一起使用。我正在寻找创建 json swagger-ui 可以读取的最佳方法 - 我应该怎么做？

此外，我很乐意检查在这种环境中记录 Rest API 的任何其他好的解决方案。

我正在尝试将一个对象和一个字符串传递给函数并在restler中对其进行测试，
但是我收到了这个错误：

在我写的文档中：

这是功能：

我正在使用restler的最新版本。

我正在尝试使用 swagger 来记录我的 Rest API。我正在开发一个 Tomcat/Spring 服务器，其余的 api 是使用 Jersey 开发的。

我遵循招摇指南并将所需的数据添加到我的 web.xml：

http://:8080/main/resources/api-docs 返回以下内容：

知道我在这里想念什么吗？

我不确定这是否是 Swagger JavaScript 或生成的 Swagger JSON 的错误，但似乎当我将 SwaggerUI 指向单个资源（即 /resource/MyResource 与 /resources）时，模型似乎没有被正确解析。当我通过“/resources”url一次性查看所有资源时，模型正确显示为响应类和输入（正文类型）参数。当我将 url 切换到单个资源时，所有模型都消失了。输入参数的名称和描述以及整体“方法签名”仍然存在。Swagger Petstore 演示似乎不会发生这种情况（尽管被授予，但它使用的是更新版本的 Swagger）。就 Swagger 相关的 API 属性而言，我应该做些什么来帮助解决这个问题？

编辑

作为一种解决方法，我对我的服务使用最新的 SwaggerUI（它基于 Swagger 1.2 规范，但我没有更改任何 ServiceStack.Api.Swagger 代码来支持它）。我不得不通过修改 swagger.js 来强制 SwaggerUI 以 JSON 格式请求资源以添加“接受：'application/json'”，但是一旦我这样做了，它似乎在指向单个资源时工作。因此，这可能只是将 ServiceStack.API.Swagger 中的嵌入式 SwaggerUI 更新到最新版本的问题。

按照此 URL 处的代码示例：

https://github.com/ServiceStack/ServiceStack/wiki/Self-hosting

我创建了一个空解决方案，将上面的 C# 代码粘贴到“program.cs”中并运行以下 nuget 命令来导入所需的库和代码文件：

该服务运行良好，大张旗鼓的元数据正确传递，但是在尝试访问时/swagger-ui/index.html出现错误'Handler not found'。

我通过 dropbox 分享了我的基本示例代码：

ServiceStackSelfhosted.zip (2.5 MB)

ServiceStackSelfhosted_stripped.zip （8 Kb，但需要运行 nuget 命令）

我正在尝试使用 Swagger-Jersey-JAXRS 模块来记录一个非常简单的 RESTful 数据服务。

按照“Java JAXRS 快速入门”中的说明：https ://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart ，我用

上面的代码存在于一个名为 Provider 的类中，被注释为 JPA @Entity。

当使用 swagger-ui 可视化 REST API 时，返回“提供者”实体的 GET 操作不会在 @XmlElement 处显示 swagger 的“值”和提供的名称，如下所示：

用于返回 Providers 列表的 Java 方法如下所示：

如果我从 Provider 类中删除 JPA 注释，那么一切都会按预期工作。我的理解是 JPA 注释正在招摇。

这是我在搜索中错过的招摇的已知功能/限制/错误吗？还是我没有理解的概念。

谢谢

我一定很愚蠢，但我无法弄清楚 [Api] 属性的使用实际上对ServiceStack 的 SwaggerFeature做了什么。

不标记 [Api] 似乎不会影响 api 是否出现在 Swagger 中，并且在使用它时我找不到任何地方呈现的描述，例如 [Api("Service Description")]

我的用法是这样的：

在 Swagger-UI 中，结果在展开时显示在页面上：

我想使用 swagger 来记录我们的 RESTful API。我们的 Jersey 课程将从 mule 流中消耗。要使用 swagger 记录我的 API，我需要使用此处提到的 servlet 配置 - https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart

由于 Jersey 类部署在 mule 中，因此没有 web.XML。

如果您知道如何使用 Mule 配置 swagger，请告诉我如何操作。我非常感谢您的反馈和建议。

我正在使用 Swagger 为 Apache CXF RESTful API 生成文档。我有 xsd 和 DTO 是使用 xjc 插件从 xsd 生成的。我希望 swagger 在响应类 - swagger 的模型部分下显示来自 xsd 的每个元素的文档。

我无法控制生成的 DTO，因为它在多个项目中共享。如某些示例中所建议的，我无法使用 swagger 注释来注释 DTO 对象。

我有一个要记录的 REST 服务，其中一些接受简单的数组，例如：

我如何在 Swagger 模型部分对此进行描述？我只能像这样创建“命名数组”

但它描述了这样的数据：