OpenAPIのスナップショットテスト追加&不要なQueryを省く #992
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
内容
こちら↓のプルリクエストをマージしたとき、APIが意図しない形で変わりました。
クエリパラメータだったのがリクエストボディに変わった感じです。ちなみにそれを @sabonerune さんが気づいて直してくださいました。
APIの形が(FastAPIの知識不足で)意図せず変わってしまうことがわかりました。
結構怖いので、APIの形であるOpenAPIのスナップショットテストを追加しました。
ついでに知識をつけて不要なことがわかった
= Query()
をいくつか削除しています。その他
ちなみに、もし #826 の変更で意図せずAPIが変わっていたところは、OpenAPIの差分としてはこんな感じで表示されます。
たしかに
requestBody
内にあったのがin: query
内に移ってしまってるのですが、この差分を見れば問題に気づけたかというと・・・・・・・・ 😇まあでもAPIの形を意識できるので、良いかなと。