REST-API-Design-Guide

REST-API-Design-Guide copied to clipboard

Identify a ressource by a composite key

4

Hi, in our job we hav a resource that has a verion and for a business case the only identifier possible is a composite key so we came to these...

kenji-getpowered

Section about compression

2

Goal: explain how to optimize for compactness

dsebastien

See https://dzone.com/articles/dynamically-filter-json-with-jackson-and-squiggly?edition=292930&utm_source=Daily%20Digest&utm_medium=email&utm_campaign=dd%202017-04-26 https://github.com/bohnman/squiggly-filter-jackson

dsebastien

Goal: provide explanations and examples in the design about discoverability, links generation, where and how links should be in the payloads. Refer to HAL.

dsebastien

Internationalization: support the definition of multiple languages via the URL

2

You MAY also support the definition of multiple languages just like with the Accept-Language header. Design for this approach?

dsebastien

Points yet to clarify: * whether the charset matters and the impact it can have on requests going through infrastructure components / request interceptors * whether the Content-Type matters (same...

dsebastien

Goal: visualize the design workflow and work it out further. Integrate with contract-first approach..

dsebastien

Goal: add support for an "_embed" query parameter for retrieval. Should embed related entities on demand

dsebastien