Swagger POST с json body

Question

Я пытаюсь написать статический файл .json файла ответа сервера с использованием swagger. Я застрял с почтовым телом и не знаю, как это описать. Он похож на Grooveshark api, где у вас есть одна страница и разные параметры сообщений.

Таким образом, учитывая Grooveshark пример (http://developers.grooveshark.com/docs/public_api/v3/)

Страница, которая принимает запросы:

http://api.grooveshark.com/ws3.php?sig=cd3ccc949251e0ece014d620bbf306e7 

POST тело:

{'method': 'addUserFavoriteSong', 'parameters': {'songID': 0}, 'header': {'wsKey': 'key', 'sessionID': 'sessionID'}} 

Как я могу описать это с развязностью?

Answer 1

, не зная тонну о том, как этот API работает (например, в «songID» единственный параметр типа ?, Я предполагаю, что вы хотели бы что-то подобное в вашей модели раздела:

"models": { 
    "FavoriteSong": { 
    "id": "FavoriteSong", 
    "properties": { 
     "parameters": { 
     "type": "Parameter" 
     }, 
     "header": { 
     "type": "Header" 
     } 
    } 
    }, 
    "Parameter": { 
    "id": "Parameter", 
     "properties": { 
     "songID": { 
      "type": "integer", 
      "format": "int32" 
     } 
     } 
    } 
    "Header": { 
    "id": "Header", 
     "properties": { 
     "wsKey": { 
      "type": "string" 
     }, 
     "sessionID": { 
      "type": "string" 
     } 
     } 
    } 
    } 
} 

И операция будет иметь тип «FavoriteSong» как тип кузова:

"parameters": [ 
    { 
    "name": "body", 
    "description": "object to add", 
    "required": true, 
    "type": "FavoriteSong", 
    "paramType": "body" 
    } 
]