Exploring Api's with Spring Boot HAL Explorer

  1.  HAL stands for JSON Hypertext Application Language
    1. Its a simple formate that gives a consistent and easy way to hyperlink between resources in our API
  2.  HAL Explorer
    1. is an API Explorer for Restful Hypermedia API's Using HAL
    2. It helps you to enable your non-technical teams to play with API's
  3.  Spring Boot HAL Explorer
    1. Auto Configures HAL Explorer for Spring boot Projects
    2. spring-data-rest-hal-explorer
Step 1:  Add HAL dependacny

<dependency>

<groupId>org.springframework.data</groupId>

<artifactId>spring-data-rest-hal-explorer</artifactId>

</dependency>


Step 2:  Url run http://localhost:8080/


you will get  http://localhost:8080/explorer/index.html#uri=/

HAL explorer come in 



Step 3: By Searching actuator in edit headers will get links 
Step 4: we can also test our Api which has links 

Like :
  "_links": {
    "all-users": {
      "href": "http://localhost:8080/users"
    }





Previous
Next

Comments

Post a Comment

Popular posts from this blog

Step 1 Rest With Spring Boot

Image
How to Build Rest API  Identify Resources: (/user, /user/{id})  etc.  Identify Actions (GET, POST, PUT, DELETE, PATCH etc.)  Defining Request and Response Structure  Define  Response Status( 200 as Ok, 404 as Page Not Found, 500 Internal Server Error)     400 Series Errors:  Client Side Error     500 Series Errors:  Server Side Error  Best Practices for Rest API 1.Thinking on Consumer Perspective 2. validation  3  Internationalizations -i18n 4. Exception Handling 5. HATEOAS 6. Versioning 7. Documentation  8. Content Negotiation etc.  Internal Working of Spring Boot 1.   How to Handle Request in Spring Boot? Dispatcher Servlet- Front Controller Pattern Mapping Servlets: dispatcher Servlet urls=[/]  ( as dispatcher servlet is mapped to the [/] root URL)   If you search for Mapping servlets you will find out the given below string in logs which is telling to you dispatcher servlet is ma...
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

How to User Path variable

  How to User Path variable @ PathVariable   is used for add the variable in the path of your URL and use into the code  @RestController @RequestMapping (path = "/by" ) public class ByWorldController { @GetMapping (path = "/hello-world/path-variable/{name}/{gender}" ) public HelloWorldBean helloWorldPathVariable( @PathVariable String name , @PathVariable String gender ) {          if ( gender . equalsIgnoreCase ( "m" )) {                  return new HelloWorldBean(String. format ( "Hello Mr %s" , name ));          } else if ( gender . equalsIgnoreCase ( "f" )) {                  return new HelloWorldBean(String. format ( "Hello Mrs %s" , name ));          }  ...
Read more