How to use hypermedia
REST
According to this approach, by accessing a resource, the server's response contains hyperlinks to other actions that can be performed on the resource |
| Use absolute URIs in the results |
REST Resources
Hypertext Linking within an Entity |
3.3 Representations
3.3.3 A resource identifier labeled "url" MUST be present in all RESTful API resource representations |
| Hypermedia / HATEOAS |
Collection GET endpoints
should link to relations next and prev for pagination purposes |
Public-friendly APIs
While it is still recommended to include hypermedia links to encourage good practices, is it not mandated like for internal services. |
| Expanding Resources Through Hypermedia Linking |
| Support Hypermedia |
| Hypermedia and REST |
| Relationships and Sub-Resources |
| Hypermedia Links (Pagination) |
| Hypermedia Response Format |
| Paging Hypermedia Links |
Create New Resource
Hypermedia links provide an easy way to get the URL of the newly created resource |