2016-10-05 3 views
2

私はサイトのAPIを作ってるんだと私は闊歩UIを使用しています、私は現在、ルートが"https://stackoverflow.com/users/{id}/favorites/"あるユーザーのための好みを追加するためのルートを持っている、とスペックでのparamsは、次のとおりです。Swagger UIでAPIリクエストのサンプル値を変更するにはどうすればよいですか?

 "parameters":[ 
      { 
      "in":"path", 
      "name":"id", 
      "description":"User's Id", 
      "required":true, 
      "schema":{ 
       "$ref":"#/definitions/User" 
      } 
      }, 
      { 
      "in":"body", 
      "name":"body", 
      "description":"Enter user's id and video id for favorite", 
      "required":true, 
      "schema":{ 
       "$ref":"#/definitions/Favorite" 
      } 
      } 
     ], 
スペックでお気に入りのモデルの

定義は次のようになります。

"Favorite":{ 
    "type":"object", 
    "properties":{ 
    "id":{ 
     "type":"integer", 
     "format": "int64" 
    }, 
    "userId":{ 
     "$ref":"#/definitions/User/properties/id" 
    }, 
    "videoId":{ 
     "$ref":"#/definitions/Video/properties/id" 
    } 
    }, 
    "xml":{ 
    "name":"Flag" 
    } 
} 

しかし、私は/apiルートを移動する場合、現在の身体のparamのために示されている例値は

{ 
    "id": 0 
} 
ですそれは正しく、ほぼ正しい要求のサンプルを表示して示してドキュメント上の

:私は例として

{ 
    "userId": 0, 
    "videoId": 0 
} 

を表示する/apiルートの例の値を変更し、どのように行うにはどうすればよい

{ 
    "id": 0, 
    "userId": 0, 
    "videoId": 0 
} 

私は、docの例からidパラメータを削除します

答えて

0

これが最良の方法であるかどうかはわかりませんが、私は定義を変更して、$ refと同じfの代わりにuserIdをintにしましたまたはvideoId。

関連する問題