7

swagger を使用してサーバー応答の静的 .json ファイルを書き込もうとしています。投稿本文に行き詰まっており、それを説明する方法がわかりません。これは、1 つのページと異なる投稿パラメータを持つ Grooveshark API とほとんど同じように見えます。

したがって、与えられたgroovesharkの例（http://developers.grooveshark.com/docs/public_api/v3/）

クエリを受け取るページ:

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

投稿本文:

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

これを闊歩でどのように説明できますか？

4

1 に答える 1

8

この 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"
  }
]
于 2013-11-11T17:03:25.807 に答える