api_design.htm
Designing API for Humans (source)
Object IDs
- Avoid
id = 42 - Use universally unique identifiers (UUID):
4c4a82ed-a3e1-4c56-aa0a-26962ddd0425 - Or even better, add a prefix to them:
pi_3LKQhvGUcADgqoEM3bh6pslE
Error messages
Avoid error messages in 200 status.