Jamie Service

Required Software

• You must have the Go Programming Language installed in your machine to run this project. You can get the official download here.

Initializate the project

• Clone this project to your local machine.
• On main.go folder (../jamie-service/main.go), open your local terminal and type the command go run main.go, if your OS is windows, you can by build and run the executable go build && ./jamie-service.exe, or if your OS is mac or linux, type the command go build -o service && ./service $@.

Using main endpoints

By default the port will be :8005

• GET http://localhost:YOURSETTEDPORT/

  • Will return simple message to client such as: "Jamie Service Works!!!"

• GET http://localhost:YOURSEETEDPORT/swagger/index.html

  • On your browser, you can see the swagger documentation of the api.

• GET http://localhost:YOURSEETEDPORT/health/live?full=1

  • This endpoint will check the live status of the application, just like that:

    {
    	"goroutine-threshold": "OK"
    }

• GET http://localhost:YOURSEETEDPORT/health/ready?full=1

  • This endpoint will check the ready status of the services used by ruller project

  {
  	"goroutine-threshold": "OK",
  	"resource-loader": "OK"
  }