fix: diverging axum route and openapi spec #1199
Merged
+54
−5
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.
Currently there is the possibility that the swagger-ui does not work with
utoipa_axum
in certain conditions.The reason for this is, that the path resolution in the
.nest(router)
function is different in axum and utoipa.This pull request fixes it by applying the same logic for the OpenAPI spec generation, that is used in axum.
How to reproduce this issue
With the following minimal reproducible example, open the swagger ui on
localhost:3000/docs
.The only endpoint is
/a/
, but when you perform the request, it returns404 Not Found
.Cause of the issue
In Axum the
.nest
logic joins the prefix and nested path in a different way than utopia. E.g. for nested routes the trailing/
is stripped away and other logic to prevent double//
in the joined path.