swagger.yaml 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. swagger: "2.0"
  2. info:
  3. description: "The gomicro service is a template for all microservices written in go for our dm product."
  4. version: "1.0.0"
  5. title: "GoMicro Service Template"
  6. termsOfService: "http://www.easy.de/"
  7. contact:
  8. email: "info@easy.de"
  9. license:
  10. name: "EASY License"
  11. url: "http://www.easy.de/"
  12. host: "gomicro"
  13. basePath: "/v1"
  14. tags:
  15. - name: "health"
  16. description: "readiness/healthcheck endpoints"
  17. schemes:
  18. - "https"
  19. - "http"
  20. paths:
  21. /health/health:
  22. get:
  23. tags:
  24. - "health"
  25. summary: "getting the actual health status of the service"
  26. description: "getting the actual health status of the service"
  27. operationId: "healthcheck"
  28. schemes:
  29. - "http"
  30. produces:
  31. - "application/json"
  32. responses:
  33. 200:
  34. description: "service is healthy"
  35. 503:
  36. description: "service is unhealthy"
  37. /health/readiness:
  38. get:
  39. tags:
  40. - "health"
  41. summary: "service is ready to get traffic"
  42. description: ""
  43. operationId: "readinesscheck"
  44. schemes:
  45. - "http"
  46. produces:
  47. - "application/json"
  48. responses:
  49. 200:
  50. description: "service is ready"
  51. securityDefinitions:
  52. general_auth:
  53. type: "oauth2"
  54. authorizationUrl: "http://petstore.swagger.io/oauth/dialog"
  55. flow: "implicit"
  56. scopes:
  57. write:pets: "modify pets in your account"
  58. read:pets: "read your pets"
  59. api_key:
  60. type: "apiKey"
  61. name: "X-es-apikey"
  62. in: "header"