Swagger generation from controller for /path/{*param} generates param as a query param

[paulomorgado]

Given this controller action:

[Route("path/{*param}")

generates the parameter param as in:query, whereas this controller action:

[Route("path/{param}")

generates the parameter param as in:path.

[RicoSuter]

What is the expected behavior of {*param}?

[paulomorgado]

It should by in:path. Shouldn't it?

At least, that's how the client generator interprets it.

[RicoSuter]

The question is how does web api/asp.net core interpret it?

[paulomorgado]

ASP.NET interprets it as in:path. I would expect ASP.NET core to do the same.

NSwag generated clients from swagger definitions in the form of path/{*param} also treat it as in:path.

[paulomorgado]

Sorry for not testing before, but, for this path:

/Inbound/{uid}/{*topic}

The generated C# client has this:

var urlBuilder_ = new System.Text.StringBuilder();
urlBuilder_.Append("Inbound/{uid}/{*topic}");
urlBuilder_.Replace("{uid}", System.Uri.EscapeDataString(System.Convert.ToString(uid, System.Globalization.CultureInfo.InvariantCulture)));
urlBuilder_.Replace("{topic}", System.Uri.EscapeDataString(System.Convert.ToString(topic, System.Globalization.CultureInfo.InvariantCulture)));

where it should be

var urlBuilder_ = new System.Text.StringBuilder();
urlBuilder_.Append("Inbound/{uid}/{*topic}");
urlBuilder_.Replace("{uid}", System.Uri.EscapeDataString(System.Convert.ToString(uid, System.Globalization.CultureInfo.InvariantCulture)));
urlBuilder_.Replace("{*topic}", System.Uri.EscapeDataString(System.Convert.ToString(topic, System.Globalization.CultureInfo.InvariantCulture)));

The * is missing in the URL replacement pattern.

[paulomorgado]

I need to have a better look at this. Probably will take some spec reading.

This way is also escaping the / on topic and that's not what I'm expecting/needing.

If my route is:

[RoutePrefix("path1/path2")]
[Route("path3/{id}/{*topic}")]

This URL:

http://host:port/path1/path2/path3/id/my/special/topic

will yield a value of my/special/topic for topic.

So, when there's an *, there seems to be no path escaping involved.

[RicoSuter]

I think we have to remove the wildcard as swagger does not support it i believe. The problem is how we could detect if escaping is needed or not... I think we should just remove the wildcard in the spec and not escape any path param....

[RicoSuter]

See

• https://github.com/OAI/OpenAPI-Specification/issues/291
• https://stackoverflow.com/questions/42335178/swagger-wildcard-path-parameters

[RicoSuter]

For now, we have to treat them as normal string path parameters... The problem is, that path parameters are escaped in the client - so you cannot pass /s... Any idea how to fix that? Maybe we add a custom field? E.g. "x-wildcard": true (which does not render System.Uri.EscapeDataString( in the client?

[paulomorgado]

What do we do with the *? Just not support it?

[RicoSuter]

... see my updated comment above. Not really an ideal solution.

[paulomorgado]

So, in my example, the parameter would be called topic although the path is path1/path2/path3/{id}/{*topic}?

*topic is not a valid C# or TypeScript identifier.

[RicoSuter]

For now, the * is just ignored/removed... Any idea how we should supported that even if Swagger is missing this feature?

[paulomorgado]

What makes sense is for the wildcard only be allowed on the last path parameter and to just not escape it.

I'm using an API Manager (http://wso2.com/products/api-manager) where this route/resource is defined as path1/path2/path3/{id}/* and, in this case, I would like to have a parameter generated for that too.

[A143730]

hey @paulomorgado - did you get any resolution for this issue, i am also facing the same where the apim path expects / while in .net core the route is /{path} where path includes slashes as well

[paulomorgado]

Sorry, haven't worked with this for about 2 years.