Onde devem estar os valores dos parâmetros para esta API REST e por quê?

Question

Eu tenho a seguinte API REST:

POST /users/martin/notify/...

A API deve notificar uma lista de usuários de que o usuário Martin tem algo a dizer.A lista de usuários a serem notificados pode variar de 1 a mil.Onde a lista de mil usuários deve estar: Querystring, HTTP Header ou o corpo da solicitação?Por quê?

Answer 1

Corpo da solicitação.Os cabeçalhos e strings de consulta geralmente têm limitações de tamanho na prática que você definitivamente teria com milhares de identificadores.Em um nível mais teórico, o corpo da solicitação deve ser a entidade que você deseja que o servidor processe via POST.Os cabeçalhos são para metadados de nível de protocolo sobre essa entidade;ou seja, informações que ajudam a entidade a ser processada, mas não a própria entidade.Querystrings são parte do identificador do recurso, e também não são uma representação desse recurso.