add golang rest-api sample

Author: ChathurangaKCD

go/rest-api/.gitignore

@@ -0,0 +1,2 @@
+/main
+.DS_Store

go/rest-api/Dockerfile

@@ -0,0 +1,21 @@
+FROM golang:1.18.0-alpine as build-env
+
+RUN mkdir /app
+WORKDIR /app
+COPY go.mod go.sum ./
+
+# Get dependancies - will also be cached if we won't change mod/sum
+RUN go mod download
+
+# COPY the source code as the last step
+COPY . .
+
+
+# Build the binary
+ENV CGO_ENABLED=0 GOOS=linux GOARCH=amd64
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -installsuffix cgo -o /go/bin/app -buildvcs=false
+
+FROM alpine
+COPY --from=build-env /go/bin/app /go/bin/app
+USER 10014
+ENTRYPOINT ["/go/bin/app"]

go/rest-api/README.md

@@ -0,0 +1,29 @@
+# Choreo Samples
+
+## Sample Go API
+
+#### Use the following build config when creating this component in Choreo:
+
+- Dockerfile: `go/rest-api/Dockerfile`
+- Docker context: `go/rest-api/`
+- Port: `8080` (or set env var `PORT`)
+- OpenAPI filepath: `go/rest-api/docs/swagger.json`
+
+#### Go build & run
+
+```shell
+go build main.go && go run main.go
+```
+
+#### Generate API definitions
+
+Generated using Go annotations https://github.com/swaggo/swag
+
+```shell
+swag init
+```
+
+#### Load initial data ( optional )
+
+1. Set env var in Choreo DevOps portal `INIT_DATA_PATH=<some_path>`
+2. Mount the file contents of `configs/initial_data.json` in the path specified in step 1.

go/rest-api/api/routes/api_v1.go

@@ -0,0 +1,14 @@
+package routes
+
+import (
+	"github.com/gofiber/fiber/v2"
+)
+
+func Initialize(app *fiber.App) {
+	initControllers()
+
+	RegisterHealthRoutes(app)
+	apiVersion := app.Group("/api/v1")
+	registerPetRoutes(apiVersion)
+	registerCategoryRoutes(apiVersion)
+}

go/rest-api/api/routes/category.go

@@ -0,0 +1,55 @@
+package routes
+
+import (
+	"github.com/gofiber/fiber/v2"
+
+	"example.choreo.dev/internal/controllers"
+	"example.choreo.dev/internal/utils"
+)
+
+func registerCategoryRoutes(router fiber.Router) {
+	r := router.Group("/category")
+	r.Post("/", CreateCategory)
+	r.Get("/", ListCategories)
+}
+
+// CreateCategory
+// @Summary      Add pet to the store
+// @Accept       json
+// @Produce      json
+// @Param request body controllers.AddCategoryRequest true "pet details"
+// @Router /api/v1/category [post]
+// @Failure 409  {object}  any
+// @Success 200 {object} controllers.AddCategoryResponse "ok"
+func CreateCategory(c *fiber.Ctx) error {
+	ctx := utils.GetRequestContext(c)
+	var req controllers.AddCategoryRequest
+
+	if err := c.BodyParser(&req); err != nil {
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"status":  "error",
+			"details": "failed to parse payload",
+		})
+	}
+
+	res, err := categoryController.AddCategory(ctx, req)
+	if err != nil {
+		return err
+	}
+	return c.Status(fiber.StatusOK).JSON(res)
+}
+
+// ListCategories
+// @Summary      List available categories
+// @Produce      json
+// @Router /api/v1/category [get]
+// @Success 200 {object} controllers.ListCategoriesResponse "ok"
+func ListCategories(c *fiber.Ctx) error {
+	ctx := utils.GetRequestContext(c)
+
+	res, err := categoryController.ListCategories(ctx)
+	if err != nil {
+		return err
+	}
+	return c.Status(fiber.StatusOK).JSON(res)
+}

go/rest-api/api/routes/healthz.go

@@ -0,0 +1,25 @@
+package routes
+
+import (
+	"time"
+
+	"github.com/gofiber/fiber/v2"
+
+	"example.choreo.dev/internal/config"
+)
+
+// @Summary      Get pet info by id
+// @Produce      json
+// @Router /healthz [post]
+// @Success 200 {object} map[string]any "ok"
+func handleHealthCheckRequest(ctx *fiber.Ctx) error {
+	return ctx.JSON(fiber.Map{
+		"message":   "choreo-example-app is healthy",
+		"env":       config.GetConfig().Env,
+		"timestamp": time.Now(),
+	})
+}
+
+func RegisterHealthRoutes(r fiber.Router) {
+	r.Get("/healthz", handleHealthCheckRequest)
+}

go/rest-api/api/routes/init_controllers.go

@@ -0,0 +1,18 @@
+package routes
+
+import (
+	"example.choreo.dev/internal/config"
+	"example.choreo.dev/internal/controllers"
+	"example.choreo.dev/internal/repositories"
+)
+
+var petController *controllers.PetController
+var categoryController *controllers.CategoryController
+
+func initControllers() {
+	initialData := config.LoadInitialData()
+	categoryRepository := repositories.NewCategoryRepository(initialData.Categories)
+	petRepository := repositories.NewPetRepository(initialData.Pets)
+	petController = controllers.NewPetController(petRepository, categoryRepository)
+	categoryController = controllers.NewCategoryController(categoryRepository)
+}

go/rest-api/api/routes/pet.go

@@ -0,0 +1,56 @@
+package routes
+
+import (
+	"github.com/gofiber/fiber/v2"
+
+	"example.choreo.dev/internal/controllers"
+	"example.choreo.dev/internal/utils"
+)
+
+func registerPetRoutes(router fiber.Router) {
+	r := router.Group("/pet")
+	r.Post("/", CreatePet)
+	r.Get("/:id", GetPet)
+}
+
+// CreatePet
+// @Summary      Add pet to the store
+// @Accept       json
+// @Produce      json
+// @Param request body controllers.AddPetRequest true "pet details"
+// @Router /api/v1/pet [post]
+// @Success 200 {object} controllers.AddPetResponse "ok"
+func CreatePet(c *fiber.Ctx) error {
+	ctx := utils.GetRequestContext(c)
+	var req controllers.AddPetRequest
+
+	if err := c.BodyParser(&req); err != nil {
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"status":  "error",
+			"details": "failed to parse payload",
+		})
+	}
+
+	res, err := petController.AddPet(ctx, req)
+	if err != nil {
+		return err
+	}
+	return c.Status(fiber.StatusOK).JSON(res)
+}
+
+// GetPet
+// @Summary      Get pet info by id
+// @Produce      json
+// @Param id path string true "Pet ID"
+// @Router /api/v1/pet/{id} [get]
+// @Success 200 {object} controllers.GetPetByIdResponse "ok"
+func GetPet(c *fiber.Ctx) error {
+	ctx := utils.GetRequestContext(c)
+	id := c.Params("id")
+
+	res, err := petController.GetPetById(ctx, id)
+	if err != nil {
+		return err
+	}
+	return c.Status(fiber.StatusOK).JSON(res)
+}

go/rest-api/configs/initial_data.json

@@ -0,0 +1,32 @@
+{
+  "categories": [
+    {
+      "id": "10b42501-aead-4038-b548-fad045602d96",
+      "name": "c1"
+    },
+    {
+      "id": "86ea4178-637e-441f-9603-743094a2d1b9",
+      "name": "c2"
+    }
+  ],
+  "pets": [
+    {
+      "id": "d78bf645-0000-4a2d-9534-78bcb0b9f393",
+      "name": "p1",
+      "category_id": "45dc4abb-1625-4c8c-85c1-4fcabda18873",
+      "available": false
+    },
+    {
+      "id": "8cd7bacd-16dd-4b1a-96d6-1ca09e720d41",
+      "name": "p2",
+      "category_id": "45dc4abb-1625-4c8c-85c1-4fcabda18873",
+      "available": false
+    },
+    {
+      "id": "d6ebd120-2b21-4210-a482-c919c90eda73",
+      "name": "p3",
+      "category_id": "45dc4abb-1625-4c8c-85c1-4fcabda18873",
+      "available": false
+    }
+  ]
+}