API Specification?
Els principis de REST requereixen que la resposta del servidor contingui el següent:
HTTP Status
El codi HTTP Status conté un codi d'estat de tres dígits que comunica si la sol·licitud s'ha processat correctament o ha donat un error. Per exemple, els codis 2XX indiquen que el procés és correcte, però els codis 4XX i 5X indiquen errors. Els codis 3XX indiquen que hi ha una redirecció de URL.
Per exemple,
- 200: resposta genèrica de processament correcte
- 201: resposta de processament correcte del mètode POST
- 400: resposta incorrecta que el servidor no pot processar
- 404: recurs no trobat
Cos de missatge
El cos de la resposta conté la representació del recurs. El servidor seleccionarà un format de representació adient en funció del que continguin les capçaleres de la sol·licitud. Els clients ens poden demanar informació en formats XML o JSON o fins i tot en text sense format.
Per exemple, si un client sol·licita el nom i l'edat d'una persona anomenada Joan, el servidor podria retornar una representació JSON com la següent:
'{"name":"Joan", "age":30}'
Capçaleres
La resposta també conté capçaleres o metadades sobre la resposta. Aquests afegeixen més context sobre la resposta o poden incloure informació addicional del servidor, com codificació, data, tipus de contingut, etc.