How to Implement API Versioning for Minimal APIs | ASP.NET Core 8

[@MilanJovanovicTech]

Want to master Clean Architecture? Go here: bit.ly/3PupkOJ Want to unlock Modular Monoliths? Go here: bit.ly/3SXlzSt

[@codeme8016]

Very clear. Some tutorials aren't but this one was outstanding. Thank you!

[@MilanJovanovicTech]

Glad you enjoyed it! When you say "Some tutorials aren't" - do you mean on my channel? I'd appreciate any feedback, if you're keen on sharing.

[@stratvids]

We use a url version number and actually build each major version of the api as a separate container, this really keeps the services from becoming a mess of multiple versions mixed together and you can update/deploy them independently

[@MilanJovanovicTech]

Nice strategy

[@developmentroselino]

milan saved the day once again

[@MilanJovanovicTech]

Happy to help! 😁

[@alexmadnix]

Great video as always!

[@MilanJovanovicTech]

I appreciate that

[@XelleczixTV]

Love your videos! A little tip: you should increase the volume of your mic 😊 Have to turn up quite a lot to hear you clearly.

[@MilanJovanovicTech]

Thank you! Will do!

[@kyamcollados8538]

hey man, i tried to follow your tutorial and i got stuck in the swagger ui page. i could not see the v2 in the dropdown. anything i missed?

[@MilanJovanovicTech]

Register the Minimal API endpoints before configuring Swagger options?

[@xentricator]

@MilanJovanovicTech how would you implement this kind of versioning when the seperate versions have a different contract (which is usually the reason why you would create another version, due to it being a different contract often results in breaking changes). Currently in your example you are always routing to the same implementation with the same contract whether it's v1 or v2.

[@MilanJovanovicTech]

You can define two request contracts, and expose each one on the respective endpoint V1 or V2

[@10Totti]

Nice tutorial thanks!

[@MilanJovanovicTech]

You're welcome!

[@sunzhang-d9v]

CreateUser API, there is only one V1 version, but the V2 version of SwaggerUI also appears, how to make the V2 version not displayed?

[@MilanJovanovicTech]

Nope, both V1 and V2 were configured for all APIs

[@heischono4917]

Thanks for this video. I miss the case when I wish to go over from a MVC Api (v1) to Minimal Api (v2). Is it simple to mix these 2 kinds of Api or should I use a more simple approach with manually define v2 in the routes?

[@MilanJovanovicTech]

Haven't thought of that. Makes me wonder if the routes will conflict in any way, but I assume not.

[@MrNobody-f8f]

hey milan thanks. did you try with version 8.1.0? it will say that the swagger endpoint is not found

[@MilanJovanovicTech]

No, I did not. But I'll check it out and see why that could be

[@andyhb1970]

When using the version number as part of the route can you still use Postman to import the OpenAPI as I'm only seeing the v1 assuming it was part of the same issue as the swagger UI I tried adding the swagger gen option configuration elements but it still only returns version 1?

[@MilanJovanovicTech]

The v2 is a different Open API document - so you'd have to import both

[@andyhb1970]

@@MilanJovanovicTech ah yes of course, sorry I have become used to copying and pasting the OpenAPI link I didn't pay the version part of the route any attention, infact in postman if you paste the link it auto submits it! Thanks for your prompt response.

[@FungoTech]

Thanks, great example of configuration.

[@MilanJovanovicTech]

Glad it was helpful!

[@pa1kota]

Great Tutorial and would love to see if this also included how to default to v1 when v2 is introduced so that Postman call doesn't have to change. This would be a good example where legacy clients can continue without change of url.

[@MilanJovanovicTech]

With URI versioning, I don't think it can be done since the version is "hard-coded" on the calling side

[@pa1kota]

@@MilanJovanovicTech Yes right. Thank you :-)

[@Midicifu]

Can't be this done with a middleware or a proxy (yarp or code) with transforms and with white list to the break changes?

[@vishalpawarsblogs8077]

when we define route with `v{v:apiVersion}/controller` , how default version will work? how AssumeDefaultVersionWhenUnspecified will work in such case?

[@MilanJovanovicTech]

You're going to configure one of the API versions as "default": 4:35

[@kien-dang]

Hey Milan, how can you implement API versioning to work with Carter? I use vertical slide architecture with the implementation of ICarterModule and AddRoutes separately in individual classes. I don't want to declare NewApiVersionSet repeatedly in many AddRoutes(IEndpointRouteBuilder app). Thanks

[@MilanJovanovicTech]

Doesn't Carter have an abstraction for something like that? I would be surprised that it's not supported

[@kien-dang]

I've been searching around but it seems doesn't have something for that. I might have to implement an extension myself. Thanks for the video and that would be great if you can find another way to work with Carter for this matter.

[@Yehor-Lesnevych]

Hey! I have an issue with swagger and api versioning. I did all the steps in the video but calling app.DescribeApiVersions() throws exception "System.FormatException: 'Input string was not in a correct format.'"

[@MilanJovanovicTech]

Did you configure the required services?

[@Yehor-Lesnevych]

​@@MilanJovanovicTech yes, I did. builder.Servises.ConfigureOptions()

[@Yehor-Lesnevych]

​@@MilanJovanovicTechyes, I did everything in video

[@andyhb1970]

Is it possible that there is an issue when using Carter to register map the endpoints, I have setup a Test endpoint with 2 versions and when I call it I get... System.InvalidOperationException: Duplicate endpoint name 'Testing' found on 'HTTP: GET api/v{apiVersion:apiVersion}/auth/testing => Logout' and 'HTTP: GET api/v{apiVersion:apiVersion}/auth/testing => Logout'. Endpoint names must be globally unique.

[@andyhb1970]

Just realized the error message was referring to the Name which you aren't setting in your example which seems to have resolved things 👍

[@MilanJovanovicTech]

Glad you fixed it 😁

[@salmanshafiq8151]

Very informative❤ What is customresults here?

[@MilanJovanovicTech]

From here: kzbin.info/www/bejne/j3OuamadoKyFoJo

[@jithin.johnson]

when using Carter, how to implement versioning?

[@MilanJovanovicTech]

Version on the route group, or when mapping the endpoint

[@TheScriptPunk]

Now this is a valuable video

[@MilanJovanovicTech]

Glad you think so 😁

[@abhikr_1997]

Content of the video is too good and I always learn something new from your videos but you haven’t talk about the breaking changes in this video. Is there a new video coming for breaking changes or missed it if I missed that concept can you please provide the timestamp. Thanks 😊

[@MilanJovanovicTech]

Yeah, it kind of went over the top of my head 😅 Check this out for more info: www.milanjovanovic.tech/blog/api-versioning-in-aspnetcore

[@abhikr_1997]

@@MilanJovanovicTech Thanks will have a look ☺️

[@raiscl]

Could we all as a group drop the X on custome headers? It's been more than a decade that this is not mandatory anymore and it is actually advised against! Besides, just polute code on FE and BE.... a part of that. Amazing tutorial!!

[@MilanJovanovicTech]

I don't know about that. I know it's not required. But I simply like having the X- prefix to denote custom headers. Also makes it easier for me to find them in source code with search.

[@chrissu9354]

hi，good vid, there's a little question which is the theme was? really awesome theme plz name for me~ thx.

[@MilanJovanovicTech]

It's ReSharper syntax highlighting

[@Megha-f7d]

I didn't see much about the vlogs of the day in the life of dotnet developers, How much they can make, what kind of companies require them and future of dotnet. Please you make

[@MilanJovanovicTech]

I doubt it

[@Paul-uo9sv]

Can we have one vid for non minimal apis?

[@MilanJovanovicTech]

Sure :)

[@ferventurart]

When a video about how add open api summary, description, params and responses (documenting our endpoints)

[@MilanJovanovicTech]

That's a great idea!

[@aamirali8114]

why dont you provide code to learn your one concept we have fill up the blank of incomplete code which take more time and we move to another syllabus and forget why we started this thing

[@MilanJovanovicTech]

I do - except it's on Patreon

[@YehorBachurinDev]

Thanks!

[@MilanJovanovicTech]

You're welcome! :)

[@JedaiasRodrigues7]

Thanks a lot! 👊

[@MilanJovanovicTech]

You bet

[@sunzhang-d9v]

Not being able to have XML comments like controllers, unhappy

[@MilanJovanovicTech]

Not a deal breaker for me

[@javidibra6786]

das ist fantastic🤩

[@MilanJovanovicTech]

Thanks a lot! :)

[@sunzhang-d9v]

good job

[@MilanJovanovicTech]

Thanks!

[@whosgotrythm]

Good video. Can you controllers in your videos as that is what commercial applications use. Still this is great info

[@MilanJovanovicTech]

Explained here: www.milanjovanovic.tech/blog/api-versioning-in-aspnetcore

[@sunzhang-d9v]

There is only one API with V1 and V2 versions, so SwaggerUI has them all

[@MilanJovanovicTech]

You can also deprecate a V1 endpoint, and it'll be greyed out in SwaggerUI