Dot net Core Web API Versioning Implementation

 Steps For API Versioning:


  1. Add new NuGet package:

    1. Microsoft.AspNetCore.Mvc.Versioning

    2. Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer


  1. Configure API Versioning Updating by startup. cs file with the following Code:

    1.   services.AddApiVersioning(options =>

            {

                options.DefaultApiVersion = new ApiVersion(1, 0);

                options.AssumeDefaultVersionWhenUnspecified = true;

                options.ReportApiVersions = true;

           });

  1.    services.AddVersionedApiExplorer(options =>

            {

// add the versioned api explorer, which also adds IApiVersionDescriptionProvider service  

// note: the specified format code will format the version as "'v'major[.minor][-status]"  

                options.GroupNameFormat = "'v'VVV";


// note: this option is only necessary when versioning by url segment. the SubstitutionFormat  

// can also be used to control the format of the API version in route templates  

                options.SubstituteApiVersionInUrl = true;

            });


  1. Configure API Versioning With Swagger Updating by StartUp.cs File

    1.             services.AddSwaggerGen(c =>

            {

              

                c.CustomSchemaIds(x => x.FullName);

// configure dropdown for Versioning in swagger page

                c.SwaggerDoc("v1", new OpenApiInfo { Title = "GurooGlobalAPI verison 1", Version = "v1" });

                c.SwaggerDoc("v2", new OpenApiInfo { Title = "GurooGlobalAPI verison 2", Version = "v2" });


     });

  1.   // specifying the Swagger JSON endpoint.

            app.UseSwaggerUI(

            options =>

            {

               

// build a swagger endpoint for each discovered API version  

                foreach (var description in provider.ApiVersionDescriptions)

               {

                    options.SwaggerEndpoint($"/swagger/{description.GroupName}/swagger.json", description.GroupName.ToUpperInvariant());

                }

            });


  1. Configure and Map-Versioning With API Controller and API Action Methods.

    1. Add Route Attribute With Routing string on API Controller

      1.   [Route("v{version:apiVersion}/[controller]")] 

    2. Add Multiple API versions support by that Controller

      1.   [ApiVersion("1")]

      2.    [ApiVersion("2")]

    3. Map API version with Action Method 

      1.    [MapToApiVersion("1")]

Ex. 

    [ApiController]

    [ApiVersion("1")]

    [ApiVersion("2")]

    [Route("v{version:apiVersion}/[controller]")]

    public class CredentialController : ControllerBase

    {

       [HttpPost]

       [Route("GetToken")]

      [MapToApiVersion("1")]

       public async Task<ActionResult<string>> GetToken()

      {

         // api body

       }


     }

Comments

Post a Comment

Popular posts from this blog

Dot Net Core Middleware (Authorization + Custom Authorize)

1. AuthorizeHelper Class: 1.  Add one helper class named AuthorizeHelper which contains GroupRoles static Dictionary, GroupRoles stored GroupId as key, and List of Roles against GroupId as   Values. a.  GroupRoles Dictionary contains RoleId, RoleName, GroupName, GroupId, and Dictionary will static means it will need to store Group Id with Roles Once for all User and if one   User will store that GroupId and Roles then other access that GroupId and Roles with DB   call.   private static Dictionary<Int64, List<UsersGroup>> GroupRoles;   public class UsersGroup { public Int64 RoleId { get; set; } public Int64 GroupId { get; set; } public string GroupName { get; set; } public string RoleName { get; set; } }   2.  Add SetRoles Static Method which is First Filter Group Ids which already have in Dictionary   and then   call   DB   for   getting   Roles   from   list   of   Group   Id...
Read more

GIT Basic Command & Git Command Flow chart

Image
Git config: This command sets the author name and email address respectively to be used with your commits. $ git config –global user.name “[name]” $ git config –global user.email “[email address]” Example: $ git config –global user.name KrishnaPatel $ git config –global user.email  patelkisu707@gmail.com   Git init: This command is used to start a new repository. $ git init [repository name] Example: $ git init Git_Learning   Git clone: This command is used to obtain a repository from an existing URL. $ git clone [url] Example: $ git clone  http://github.com/PatelKrishna123/Git_Learning   Git add: This command adds a file to the staging area. $ git add [file] Example: $ git add index.html This command adds one or more to the staging area. $ git add –AGit Commands Krishna Patel   Git commit: This command records or snapshots the file permanently in the version history. $ git commit –a –m “[Type in the commit message]” Example: $ git commit –a –m “Initial com...
Read more