API Design

What is an api? A set of rules governing how 2 different systems are allowed to interact with eachother

Responses

It’s important to signal success or failure to clients so that they know what they should do next if anything. Did their request succeed? (2xx) Did it fail permanently? (ie It’ll never succeed because it was invalid 4xx) Did it fail temporarily and they should try again? (ie Service not available, or a bug was found 5xx)

  • 2xx
  • 4xx
  • 5xx