応答に含まれるフィールドが異なる API の仕様を書いています。これを示すために、複数の例を提供できるようにしたいと思います。私のユースケースは次のとおりです。
- API 呼び出しの 1 つに
include
、応答に含める追加フィールドをユーザーが指定できるようにするパラメーターがあります。 - 一部の API 呼び出しでは、応答に含まれるフィールドは、ユーザーの API キーに関連付けられた権限によって異なります。
私ができるようにしたいのは、次のようなものです:
+ Response 200 (application/json)
{
"id": 1,
"name": "Joe Bloggs",
"email": "joe@example.com"
}
+ Response 200 (application/json)
If `include=telephone` was specified:
{
"id": 1,
"name": "Joe Bloggs",
"email": "joe@example.com",
"telephone": "0123456789"
}
+ Response 200 (application/json)
If the API key has access to address data:
{
"id": 1,
"name": "Joe Bloggs",
"email": "joe@example.com",
"address": [{
"address1": "101 My street",
"address2": "My area"
}]
}
私が知る限り、複数の応答を提供することはできますが、応答コードまたはコンテンツ タイプが異なる場合にのみ可能です。これを行う方法はありますか?