Как обернуть объекты JSON?

Question

В настоящее время я ищу способ обернуть JSON в компоненте пользовательского интерфейса Swagger.

В YAML мое заявление объект:

restException: 
    properties: 
     message: 
     type: string 

Выход генерируется Swagger UI является (whic Я согласен, правильно): { "message": "string" }

и то, что я хочу это:

"restException": { 
    "message": "string" 
} 

Я просто нашел уродливый способ сделать это, явно объявив обертку в файле YAML. Но это ужасно плохо, так как он также генерируется, когда я использую «Swagger Codegen» для генерации кода клиента или сервера.

restExceptionContainer: restException: properties: message: type: string

Я в порядке добавления кода в файле Кураж UI, если это необходимо! Нужна ваша помощь, чтобы найти где :)

Answer 1

Вы должны document restException как объект (тип: объект).

В качестве примера рассмотрите пример https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml#L646 и посмотрите, как определяются Pet и категории.

Pet: 
    type: object 
    required: 
     - name 
     - photoUrls 
    properties: 
     id: 
     type: integer 
     format: int64 
     category: 
     $ref: '#/definitions/Category' 

где категория определяется как:

Category: 
    type: object 
    properties: 
     id: 
     type: integer 
     format: int64 
     name: 
     type: string