Home/ Questions/Q 6609045
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-25T19:40:26+00:00

I was writing the spec on how to organize the query parameters that are

  • 0

I was writing the spec on how to organize the query parameters that are sent in a HTTP Request, and I came up with the following:

All parameters a prefixed with the entity to which they belong, an example “a.b”, which is read “b of entity a”, that way each parameter would be clearly mapped to the corresponding entity, but what if there were two different entities that share a query paramater?, to avoid repetition and request size I came up with the following micro format. To have a request wide entity called shared each property of shared will represent a property that is shared among entities, e.g.


POST /app/my/resource   HTTP/1.1
a.p = v
b.p = v
c.p = v
d.p = v

Here it is clear that property p is shared among a,b,c and d so this could be sent as 

POST /app/my/resource HTTP/1.1
shared.p = a:b:c:d%v

Now, the request is smaller and I’m being a bit more DRY, however this adds an extra burden to the server as it has to parse the string to process the values.

Probably in my example the differences are insignificant and I could chose either, but I’d like to know what do you think about it, what would you prefer, maybe the size of the request does not matter, or maybe the parsing of the string is not such a big deal when the length is short, but what happens when we scale the size of both the request and string which one would be better, what are the tradeoffs?

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    What you are showing is a compression algorithm. Beware that payloads often are compressed on protocol layer already (HTTP, gzip Content-Type, see HTTP compression examples). Compression algorithms are advanced enough to compress duplicate string-items, so probably you won’t win much by a custom compression.

    Generally try not to optimize prematurely. First show that you are having a response-time or payload-size issue and then optimize. Your compression algorithm itself is a good idea, but it makes payload more complicated as normal key/value pairs (xxx-form-urlencoded Content-Type). For maintenance reasons head for the simplest design possible.

    • 0