问题标签 [swagger-2.0]

我想定义一个带有键和值的对象，但不知道如何在 swagger 2.0 定义中将其定义为属性。坦率地说，如果想要能够定义强类型客户端，我不确定这是否可能。但是，我想我会问看看这是否可能/允许。

基本上，我希望能够存储以下对象：

但我不希望 usd 和 eur 必须在模式中定义。我可以执行以下操作，但我不希望预定义 usd 或 eur。我希望它接受对象键的任何值。

我是 Swagger 的新手，并且已经使用 spring mvc 实现了 Swagger UI，我想在生产/实时环境中禁用 UI。我正在努力弄清楚。

这就是我正在使用的

SwaggerConfig.java

RestController.java

我正在尝试设置 Swagger >=2.0，但我无法通过单个请求发送多个标头。那是我的 index.html js 代码：

如您所见，我添加了两个标头，但只有第一个是随请求发送的。如果我反转它们，那么另一个将被发送，但我从来没有设法发送两个。文档非常简单，并说：

笔记！您可以在单个请求中传递多个标头参数，只需为它们使用唯一名称（在上面的示例中使用了键）。

需要明确的是，两个标头都添加到 Access-Control-Allow-Headers 中，并且两者都可以由服务器单独接收，情况是我无法将它们一起发送。

问题：有人知道如何处理吗？

（还有一个重要的假设，这些标头对于我所有的 api 都是全局的，所以我想将它们直接放在 swagger ui 中，而不是记录每个 api 方法）。

用例：Hapi.js + hapi-swaggered + hapi-swaggered-ui。

Swaggered UI 提交一个数组。它传递逗号分隔的字符串而不是数组。如何让它传递正确的参数，我应该更改 Joi 的验证类型吗？我在用：

查询它：?categories=firstCategory%2CsecondCategory

查询它应该做的：?categories=firstCategory&categories=secondCategory

我正在使用 springfox-swagger2 并希望抑制 @ModelAttribute 生成文档。有谁知道我可以在配置类中设置属性以便跳过这些字段的简单方法？

谢谢！

我正在开发一个 REST API。在开发过程中，我使用邮递员（chrome 扩展）来使用和记录我的 API。这是一个很棒的工具，我的大部分 API 端点都在其中。但是，当我们即将发布时，我想大摇大摆地记录这个 API，我该怎么做呢？有没有一种方法可以根据邮递员导出生成招摇？

下面的大摇大摆的来源。当我运行 swagger-tools 验证器时，我没有收到任何错误。当我在编辑器中加载它时，我看到输出但它不正确 - 它显示错误的类型和不完整的成员对象。当我尝试使用代码生成器 cli java 工具时，出现以下错误：

711 [main] 错误 io.swagger.models.properties.PropertyBuilder - null 没有属性，null 712 [main] 警告 io.swagger.util.PropertyDeserializer - null 没有属性，null，{ENUM=null，TITLE=null，描述=null，默认值=null，模式=null，DESCRIMINATOR=null，MIN_ITEMS=null，MAX_ITEMS=null，MIN_PROPERTIES=null，MAX_PROPERTIES=null，MIN_LENGTH=null，MAX_LENGTH=null，MINIMUM=null，MAXIMUM=null，EXCLUSIVE_MINIMUM= null，EXCLUSIVE_MAXIMUM=null，UNIQUE_ITEMS=null，EXAMPLE=null，TYPE=null，FORMAT=null} 822 [main] 错误 io.swagger.codegen.DefaultCodegen - 名称 null 822 [main] 警告 io.swagger 的属性意外丢失。 codegen.DefaultCodegen - 跳过无效属性 { "type" : "array" }

我正在查看以下教程：http: //blogs.msdn.com/b/martinearn/archive/2015/03/10/using-odata-query-syntax-with-web-api.aspx

我很好奇 swagger ui 中是否支持以某种方式显示查询参数。

本质上，我希望所有用 [EnableQueryAttribute] 属性标记的调用都具有用于输入查询参数的 swagger ui，并且我不想将这些参数添加到方法调用中，我仍然希望它们位于 URL 中并为 Owin 上下文拉出。

有什么建议么？

我是使用 swagger-node (swagger-spec 2.0) 的新手，我需要我的 API 来使用和生成 XML 和 JSON（因为这是客户想要的）。目前我只关注“生产”部分。

在生成响应时，我知道我可以使用jstoxml或easyxml等工具将我的 js 对象转换为 XML 。所以问题是：在使用 swagger-node 时这是否必要，或者工具是否应该处理这个问题？我想我需要帮助我的控制器代码应该返回什么。

例如，使用 swagger 创建一个新项目 swagger project create myproject (choose express framework)

更改/helloapi 的 yaml 文件，以便get:返回 json 或 xml

然后更改 hello_world.js 控制器以返回 json 对象而不是字符串

当我启动项目并将 Postman 与 Header Accept = application/json 一起使用时，我得到了响应：

如果我更改 Header Accept application/xml，我仍然会收到 JSON 响应，而不是 XML。我希望看到的是：

我知道我的代码使用错误，res.json()因为我相信它将 Content-Type 设置为application/json.

我不知道还有什么可以用来生成 XML 响应。当我更改 res.json() 以使用 easyxml

然后我从 swagger 那里得到一个验证错误：

那么我的控制器应该如何格式化响应以返回 XML 或 JSON？

我有一个使用以下 JSON 请求正文的 POST 请求。如何使用 OpenAPI (Swagger) 描述此请求正文？

到目前为止，我尝试了以下方法，但我坚持定义 body schema。

我想将输入正文内联定义为文档示例。