用json身体摇摆POST

Question

我正在尝试使用swagger编写服务器响应的静态.json文件.我被贴在身体上,不知道如何描述它.它看起来非常类似于Grooveshark api,你有一个页面和不同的帖子参数.

所以,给出了groovehark的例子(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"
  }
]