Swagger 文档：如何更新正文的内容

Question

我是 API swagger 文档的新手，希望得到您的支持。我正在生成卷曲。在 swagger 编辑器中，我在定义部分编写了以下代码

definitions: 
  Instrument_users:
    type: "object"
    required:
    - "proposal_id" 
    - "user_id" 
    - "data_access_role"
    properties:
      proposal_id:
        type: "integer"
        example: "244"
      user_id:
        type: "integer"
        example: "1010"        
      data_access_role:
        type: "integer"
        example: "2"    
        default: "2"
    xml:
      name: "Instrument_users"

在编辑器的右侧部分生成正文，如下所述

{
  "proposal_id": "244",
  "user_id": "1010",
  "data_access_role": "2"
}

我需要编写什么代码才能在 swagger 的右侧部分中看到下面的正文内容

{ "proposal_user":
{
  "proposal_id": "244",
  "user_id": "1010",
  "data_access_role": "2"
}}

谢谢

Answer 1

你应该这样写：

definitions:
  Instrument_users:
    type: "object"
    properties:
      proposal_user:
        type: "object"
        properties:
          proposal_id:
            type: "string"
            example: "244"
          user_id:
            type: "string"
            example: "1010"
          data_access_role:
            type: "string"
            example: "2"

Swagger 文档：如何更新正文的内容

Swagger documentation: How to update the content of the body

swagger-2.0

swagger-editor