index.json 845 B

12345678910111213141516171819202122232425262728293031323334353637
  1. {
  2. "endpoints": [
  3. {
  4. "url": "/",
  5. "method": "get",
  6. "description": "returns this file"
  7. },
  8. {
  9. "url": "/user/{id}",
  10. "method": "get",
  11. "description": "returns a specific user by id"
  12. },
  13. {
  14. "url": "/data/{key}",
  15. "method": "get",
  16. "description": "returns the contents in the key"
  17. },
  18. {
  19. "url": "/data/{key}",
  20. "method": "put",
  21. "body": "Content-Type: application/json",
  22. "description": "creates or overwrites the data at the key with the body"
  23. },
  24. {
  25. "url": "/data/{key}",
  26. "method": "post",
  27. "body": "Content-Type: application/json",
  28. "description": "updates or creates the data at the key with the body"
  29. },
  30. {
  31. "url": "/data/{key}",
  32. "method": "delete",
  33. "description": "deletes the data at the key"
  34. }
  35. ],
  36. "instructions": "This file is to reveal the available endpoints for this API"
  37. }