1 Versioning Rest Api URI

 Versioning Rest Api:

  • Suppose you have built an great Rest API
    • You have 100s of cutomers
    • Now you need to implemnt a breaking change
      • Example: spltit the name into two firstName and LastName
with Api
localhost:8080/v1/person

{
    name: "irfan khan"
}

with Api
localhost:8080/v2/person

{
    "name"; {
            firstName: "irfan",
            lastName: "Khan"
    }
}

So in given above examples you can see with two different Response ,
so we can not directly implement this change into production in first api itself other wise it will hit to the other list of consumer who would want response in single name instead of split name in firstname and lastName, than all you consumer will impacted.

Solution : of given above problem is Versioning Rest API

So There are number of ways to implements versioning:
1. Url
2. Request Parameter
3. Header
4. Media Type



1.Url
first version of Person v1

Step 1:VersioningPersonController.java

@RestController

public class VersioningPersonController {

@GetMapping("/v1/person")

public Personv1 getFirstVersionOfPerson() {

return new Personv1("Irfan Khan");

}

}


Step 2: Personv1.java

public class Personv1 {

private String name;

public Personv1(String name) {

super();

this.name = name;

}

public String getName() {

return name;

}

@Override

public String toString() {

return "Personv1 [name=" + name + "]";

}

}


now run in either browser or from your Rest Client





Person v2
Step1: VersioningPersonController.java

@RestController

public class VersioningPersonController {

@GetMapping("/v2/person")

public Personv2 getSecondVersionOfPerson() {

return new Personv2(new Name("Irfan", "Khan"));

}

}


Step2: Name.java

public class Name {

private String firstName;

private String lastName;

public Name(String firstName, String lastName) {

super();

this.firstName = firstName;

this.lastName = lastName;

}

public String getFirstName() {

return firstName;

}

public String getLastName() {

return lastName;

}

@Override

public String toString() {

return "Personv2 [firstName=" + firstName + ", lastName=" + lastName + "]";

}

}


Step 3: Personv2.java

public class Personv2 {

private Name name;


public Personv2(Name name) {

super();

this.name = name;

}


public Name getName() {

return name;

}


@Override

public String toString() {

return "Personv2 [name=" + name + "]";

}

}


with given 3 classes now we have splited the name into firstname
lastName




in given above example we have done the versioning through URLS

URL Versioning
  •     http://localhost:8080/v1/person
  •     http://localhost:8080/v2/person

                                        



Previous
Next

Comments

Post a Comment

Popular posts from this blog

Introduction of RESTful Web Service

Image
Rest Web Service It Stands for Representational State Transfer who coined Rest ?  Roy Fielding, who is developed HTTP as well Rest is make Best use of HTTP: Key Abstraction - Resources: 1. A Resource has an URI (Uniform Resource Identifier)     /user/Khan/todos/1     /user/Khan/todos     /user/Khan Note: It shows we  assign a URI to Each Resource           Rest does not worry about how you are representing your  resource            is it JSON,XML or HTML 2. A Resource can have different representations     JSON     XML     HTML Methods for Resources: 1. Create Resource   : POST 2. Update Resource  : PUT 3. Get Resource        : GET 4. Delete Resource   : DELETE REST Data Exchange Format No Restriction.(But JSON format is popular in restful) Transport Only HTTP (Restricted) Service Definition No Standard (but Swagg...
Read more

Learn JPA and Hibernate

Image
https://start.spring.io/ in given above URL can   User Given Below Configuration to Create Spring Boot Project with given dependencies to enable JPA and Hibernate Spring Web Spring Data JDBC Spring Data JPA H2 Database < dependencies >      < dependency > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-data-jdbc</ artifactId >      </ dependency >      < dependency > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-data-jpa</ artifactId >      </ dependency >      < dependency > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-web</ artifactId >      </ dependency >      < dependency > < groupId >com.h2database</ groupId > < artifactId...
Read more

Implementing Dynamic Filtering for Rest API

 Implementing Static Filtering for Rest API Dynamic Filtring: Customize filtering for a bean for specific REST Api @Jsonfilter with filter Provider At Conroller class //********************** DYNAMIC FILTERING***********// @ GetMapping ( "/Dyfiltering" ) public MappingJacksonValue dynamicFiltering() { SomeBean someBean = new SomeBean( "val1" , "val2" , "val3" ); MappingJacksonValue mappingJacksonValue = new MappingJacksonValue( someBean ); SimpleBeanPropertyFilter filter = SimpleBeanPropertyFilter. filterOutAllExcept ( "field1" , "field2" ); SimpleFilterProvider filters = new SimpleFilterProvider().addFilter( "SomeBeanFilter" , filter ); mappingJacksonValue .setFilters( filters ); return mappingJacksonValue ; } //********************** DYNAMIC FILTERING***********// At Pojo Entity Class @JsonFilter ( "SomeBeanFilter" ) public class SomeBean { private String field...
Read more