Advance REST Api Features

  1. Documentations
  2. Content Negotiation
  3. Internationalization - i18n
  4. Versioning  
  5. HATEOAS
  6. Static Filtering
  7. Dynamic Filtering
  8. Monitoring
1. Documentations:

  • Consumer of your REST API should know :
    • Resources
    • Actions
    • Request/Response Structure (Constraints/Validations)
  • Chalanges:
    • Accuracy: How do you ensure that your documentations is upto date and correct?
    • Consistency: you may have 100s of REST API in an enterpriise how do you ensure all document in consistency?
  • There are two option to Create Documentation:
    • 1 Manually maintain documentation
      • Additional effort to keep it in sync with code
    • 2.Generate the Documentation from Code

Rest APi Documentation Using 
  1.     Swagger and 
  2.     Open API:

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