2016-11-12 12 views
1

スワッガーでドキュメント化されていない大規模なAPIにクライアントを書き込もうとしていて、swagger.jsonを書くと とAutoRestを使うと良い方法ですそれを達成する。この場合の「データ」は、私たちのために「クライアント」の定義になりAutoRestマップクラスをレスポンス内のサブオブジェクトにする

{ 
    "resp_code": "SUCCESS", 
    "caller_ref": "2016111116233156169531", 
    "server_ref": "2016111116233189512798", 

    "data": { 
     "id": "idstring", 
     "name": "nameString", 
     "address": "addressString", 
     ... 
     } 
} 

:場合は、このAPIはこのように、制御情報に大きなオブジェクトに各操作の 応答データをラップしていることです。 AutoRestがこの「データ」をClientクラスにマップするように、200 OK応答 スキーマと定義をswagger.jsonファイルに定義する方法はありますか? Client定義を作成するだけでなく

"responses": { 
       "200": { 
        "description": "successful operation", 
        "schema": { 
         "type": "object", 
         "properties": { 
          "data": { 
           "$ref": "#/definitions/Client" 
          } 
         }        
        } 
       } 
      } 

:答えは非常に簡単です実際には

+0

"クライアント定義"の場合は、 "データ"プロパティのクラス定義がすでに*ある*ことを意味しますか?だから、AutoRestは独自のものを生成するのではなく*あなたの*定義を使用したい(これはデフォルトの動作です)? – olydis

+0

いいえ、@olydis、下記の回答をご覧ください。コメントありがとうございました。 – lccarvalho

答えて

0

、私がしなければならなかったすべては、このような闊歩ファイルの「応答」オブジェクトを書くことです。 AutoRestは "data"オブジェクトを取得するコードを生成し、その中のクライアントへのアクセスを与えます。

関連する問題