REST API and its design principles

Pragya Keshap answered on February 20, 2023 Popularity 9/10 Helpfulness 2/10

answer REST API and its design principles

REST API and its design principles

Comment

Principles of Rest API

Client-Server decoupling. In a REST API design, client and server programs must be independent. ...

Uniform Interface. All API queries for the same resource should look the same regardless of where they come from. ...

Statelessness. ...

Layered System architecture. ...

Cacheable. ...

Code on Demand. ...

GET. ...

POST.

HATEOAS

@RestController
@RequestMapping("/users/{id}/albums")
public class AlbumsController {
    
    @Autowired
    AlbumsService albumsService;
    Logger logger = LoggerFactory.getLogger(this.getClass());
    @GetMapping( 
            produces = { 
                MediaType.APPLICATION_JSON_VALUE,
                MediaType.APPLICATION_XML_VALUE,
            })
    public List<AlbumResponseModel> userAlbums(@PathVariable String id) {

        List<AlbumResponseModel> returnValue = new ArrayList<>();
        
        List<AlbumEntity> albumsEntities = albumsService.getAlbums(id);
        
        if(albumsEntities == null || albumsEntities.isEmpty())
        {
            return returnValue;
        }
        
        Type listType = new TypeToken<List<AlbumResponseModel>>(){}.getType();
 
        returnValue = new ModelMapper().map(albumsEntities, listType);
        logger.info("Returning " + returnValue.size() + " albums");
        return returnValue;
    }
}

https://www.knowledgehut.com/blog/programming/rest-api

Popularity 9/10 Helpfulness 2/10 Language java

Source: Grepper

Tags: api design-principles java rest

Link to this answer
Share Copy Link

Contributed on Feb 20 2023

Pragya Keshap

0 Answers Avg Quality 2/10

REST API and its design principles

Contents

More Related Answers

REST API and its design principles

Grepper

Documentation

Social

Legal

Contact

Oops, You will need to install Grepper and log-in to perform this action.