OpenAPIで異なるレスポンスを返せるoneOfが便利

OpenAPI初心者の @zaru です、こんにちは。この記事ではOpenAPIのoneOfという便利な機能を紹介します。ぼくはOpenAPI歴数ヶ月ですが、今まで知らなかったのを悔やむレベルです。 oneOfとは 簡単に言うと、同じEndpointでも異なるフォーマットのレスポンスが返せる・あるいはリクエストデータを受け付けることができる機能です。別の言い方をすると XOR 排他的論理和 です。 例えば、ユーザ情報を取得するEndpointで、対象リソースが「個人ユーザ」もしくは「法人ユーザ」の2通りどちらかが返ってくるとします。「個人ユーザ」と「法人ユーザ」で返すデータフォーマットが異なるときに oneOf で「個人ユーザ」「法人ユーザ」どちらか一つが返ってくることを定義することができます。