当前位置: 首页 > 知识库问答 >
问题:

Swagger编辑器字典参数定义

西门嘉澍
2023-03-14

我正在努力研究如何在swagger editor中定义字典类型。我的POST方法的一个参数叫做“角色”,它的值是一个字典,其中键是电子邮件地址,值是整数。

共有1个答案

邢骏
2023-03-14
definitions:
  MyDictionary:
    type: object
    additionalProperties:
      type: integer


默认情况下,Swagger UI 3.x和Swagger Editor 3.x将字典呈现为包含名为<code>additionalProp*</code>的属性:

如果您想要一个更有意义的示例,请在字典模式中添加一个示例

definitions:
  MyDictionary:
    type: object
    additionalProperties:
      type: integer
    example:
      apples: 5
      oranges: 7
 类似资料:
  • 我是swagger的新手,我一直在尝试使用swagger编辑器开发api。 Swagger-codecen指出,它是一个开源代码生成器,可以直接从Swagger定义的RESTful API构建服务器存根和客户端SDK。 当我使用招摇编辑器时,我可以看到选项:生成服务器和生成客户端(我在本地运行 swagger-editor) swagger-codecen是否具有与swagger编辑器中的生成服务

  • 在“SQL 编辑器”选项卡,你可以创建和编辑视图的 SELECT 语句 SQL。Navicat Data Modeler 为编辑视图定义提供广泛的高级功能,例如:编辑代码功能、智能自动完成代码、设置 sql 格式及更多。 【提示】当你在视图创建工具创建视图,SELECT 语句将会自动生成。 美化 SQL(仅适用于非 Essentials 版) 若要格式化凌乱的 SQL 代码到一个结构良好的脚本,你

  • 如何使用以下github使用Json编辑器(https://github.com/jensoleg/swagger-ui)? 我需要使用哪些代码才能为请求正文启用JSON编辑器? 尝试更改我的代码,但对我无效。任何帮助都将不胜感激。

  • 如何设置swagger ui以正确编码参数列表?例如:我有一个服务,它接收以下格式的整数列表: 然而,在我的swagger-ui文档中,参数显示为单个文本字段,它需要一个逗号分隔的列表。如果我以这种格式提供参数,我会从service(使用RestEasy编写,顺便说一下)得到以下响应: 无法从超文本传输协议请求中提取参数:javax.ws.rs.QueryParam(\"id\")值为'1,2,3

  • 我正在尝试在在线Swagger编辑器中的用户类上定义POST方法。 我希望能够在请求正文中指定多个字段,并且我希望生成的文档能够反映出只需要两个字段,其他字段是可选的。 我必须做什么/改变才能做到这一点? 我已经尝试过使用“required”关键字的各种变体(见下图),但没有成功,它没有显示在生成的文档中(见下图右侧,我的注释为红色)。 以下是我在编辑器中的帖子定义: 这里是生成的文档预览,我已经