[API] Experiment with utoipa for API #1916
Closed
+60
−10
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.
Description
This is an experiment using utoipa to generate our OpenAPI spec. This is what it spits out:
Off the bat there are few issues compared to Poem (#1906):
There is more experimentation I could do if we wanted to go with this route, I haven't looked into how it handles more complex paths, errors, etc.
The main win with utoipa is you can use whatever framework you want, but that results in you needing to do more work yourself, leading to more opportunities for mistakes.
Naturally this is not exactly how I'd actually integrate utoipa, this is just to demonstrate what it'd look like.
Test Plan
This change is