OpenAPIのadditional_propertyオプションってなに？

背景

友人とアプリ開発をしています。わたしがRailsでバックエンドを、友人がDart/Flutterでアプリを担当しています。

Railsにapipieのgemを導入し、Swagger定義を出力できるようにしました。

出力したJSONを使って、アプリ側でコードを自動生成するようなのですが、どうもうまくいかない様子...。

調査してもらったところ「additional_propertyがfalseなのが問題」とのこと。しかしながらadditional_propertyがなんなのか、よくわかってなかったので調査しました。

※1 以下に関してはまだわかってないです。1つずつ理解を進めます。

※2 全体像がわかった時に「Flutterで利用できるswagger.jsonを出力するためのapipieの設定とハマリポイント」ついてもまとめたいと思います

「propertiesで指定したプロパティ以外も受け付けるかどうか」を指定するオプションのようです。

こちらに実例付きで詳しく説明されていました。

apipieでは、additional_propertyはfalseが初期値です。 trueにするために、以下の1行を追加すればOKです。

### apipie.rb
config.swagger_allow_additional_properties_in_response = true