Incompatibility with API versioning

[geoffroybraun]

Unfortunatly, the "SmokeMe" package is not compatible with API versioning. From a Swagger UI, we get a bad request status code, as the "/smoke" endpoint does not specify any version.

It would be useful to either override the endpoint to manually add a version, or to take into account any version NuGet package to properly set the "/smoke" endpoint to "/v1/smoke" or anything else.

[tpierrain]

Hi @geoffroybraun, thanks for reporting this!

Since the recent v3, MapSmokeEndpoint() returns an IEndpointConventionBuilder, which means you should already be able to chain API versioning metadata on it. For example, to declare the endpoint as version-neutral (i.e. it doesn't belong to any specific API version):

app.MapSmokeEndpoint()
   .WithApiVersionSet(versionSet)
   .IsApiVersionNeutral();

Or if you'd rather assign it to a specific version:

app.MapSmokeEndpoint("/v1/smoke")
   .WithApiVersionSet(versionSet)
   .MapToApiVersion(new ApiVersion(1, 0));

Note that the pattern parameter (defaulting to "/smoke") already lets you customize the route to include a version prefix.

Does this solve your problem, or is there something else the versioning middleware requires that can't be configured through the IEndpointConventionBuilder?