api.yaml 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. openapi: 3.0.3
  2. info:
  3. title: "短信报警提醒"
  4. description: "基于SpringBoot的Prometheus短信报警提醒webhook API"
  5. version: "1.0.0"
  6. servers:
  7. - url: "http://localhost:8060"
  8. paths:
  9. /sms/webhook/send:
  10. post:
  11. summary: "短信报警webhook"
  12. operationId: "send"
  13. requestBody:
  14. content:
  15. application/json:
  16. schema:
  17. type: "string"
  18. description: "AlertManager服务提醒消息JSON体"
  19. required: true
  20. responses:
  21. "200":
  22. description: "OK"
  23. /sms/webhook/test-send/{service}:
  24. get:
  25. summary: "短信服务测试"
  26. operationId: "testSend"
  27. parameters:
  28. - name: "service"
  29. in: "path"
  30. required: true
  31. schema:
  32. type: "string"
  33. responses:
  34. "200":
  35. description: "OK"
  36. content:
  37. '*/*':
  38. schema:
  39. type: "string"
  40. /sms/webhook/version:
  41. get:
  42. summary: "短信提醒服务版本"
  43. operationId: "version"
  44. responses:
  45. "200":
  46. description: "OK"
  47. content:
  48. '*/*':
  49. schema:
  50. type: "string"