feat: add find breeds API

pet-sitter · Sep 22, 2023 · 657caa6 · 657caa6
1 parent 3703bdc
commit 657caa6
Show file tree

Hide file tree

Showing 9 changed files with 307 additions and 4 deletions.
diff --git a/.env.template b/.env.template
@@ -23,3 +23,7 @@ FIREBASE_CREDENTIALS_TOKEN_URI=
 FIREBASE_CREDENTIALS_AUTH_PROVIDER_X509_CERT_URL=
 FIREBASE_CREDENTIALS_CLIENT_X509_CERT_URL=
 FIREBASE_CREDENTIALS_UNIVERSE_DOMAIN=
+
+## Scripts ##
+GOOGLE_SHEETS_API_KEY=
+BREEDS_GOOGLE_SHEETS_ID=
diff --git a/api/commonviews/common.go b/api/commonviews/common.go
@@ -5,6 +5,20 @@ import (
  "net/http"
 )
 
+type PaginatedView[T interface{}] struct {
+ Page int `json:"page"`
+ Size int `json:"size"`
+ Items []T `json:"items"`
+}
+
+func NewPaginatedView[T interface{}](page int, size int, items []T) *PaginatedView[T] {
+ return &PaginatedView[T]{
+ Page: page,
+ Size: size,
+ Items: items,
+ }
+}
+
 func writePayload(w http.ResponseWriter, headers map[string]string, payload interface{}, statusCode int) error {
  setHeaders(w, headers)
 

diff --git a/cmd/import_breeds/main.go b/cmd/import_breeds/main.go
@@ -33,7 +33,7 @@ func main() {
  log.Fatalf("error initializing google sheets client: %v\n", err)
  }
 
- spreadsheet, err := client.GetSpreadsheet(configs.BreedsSheetsID)
+ spreadsheet, err := client.GetSpreadsheet(configs.BreedsGoogleSheetsID)
 
  switch flags.petTypeToImport {
  case Cat:

diff --git a/cmd/server/handler/breed_handler.go b/cmd/server/handler/breed_handler.go
@@ -0,0 +1,68 @@
+package handler
+
+import (
+ "github.com/pet-sitter/pets-next-door-api/api/commonviews"
+ "github.com/pet-sitter/pets-next-door-api/internal/domain/pet"
+ "net/http"
+ "strconv"
+)
+
+type BreedHandler struct {
+ breedService *pet.BreedService
+}
+
+func NewBreedHandler(breedService *pet.BreedService) *BreedHandler {
+ return &BreedHandler{breedService: breedService}
+}
+
+// FindBreeds godoc
+// @Summary 견/묘종을 조회합니다.
+// @Description
+// @Tags pets
+// @Accept json
+// @Produce json
+// @Param page query int false "페이지 번호" default(1)
+// @Param size query int false "페이지 사이즈" default(20)
+// @Param pet_type query string false "펫 종류" Enums(dog, cat)
+// @Success 200 {object} commonviews.PaginatedView[pet.BreedView]
+// @Router /breeds [get]
+func (h *BreedHandler) FindBreeds(w http.ResponseWriter, r *http.Request) {
+ pageQuery := r.URL.Query().Get("page")
+ sizeQuery := r.URL.Query().Get("size")
+ petTypeQuery := r.URL.Query().Get("pet_type")
+
+ page := 1
+ size := 20
+ var err error
+
+ if pageQuery != "" {
+ page, err = strconv.Atoi(pageQuery)
+ if err != nil {
+ commonviews.BadRequest(w, nil, err.Error())
+ return
+ }
+ }
+
+ if sizeQuery != "" {
+ size, err = strconv.Atoi(sizeQuery)
+ if err != nil {
+ commonviews.BadRequest(w, nil, err.Error())
+ return
+ }
+ }
+
+ var petType *string
+ if petTypeQuery == "" {
+ petType = nil
+ } else {
+ petType = &petTypeQuery
+ }
+
+ res, err := h.breedService.FindBreeds(page, size, petType)
+ if err != nil {
+ commonviews.InternalServerError(w, nil, err.Error())
+ return
+ }
+
+ commonviews.OK(w, nil, commonviews.NewPaginatedView(page, size, res))
+}
diff --git a/cmd/server/router.go b/cmd/server/router.go
@@ -3,6 +3,7 @@ package main
 import (
  "context"
  "encoding/json"
+ "github.com/pet-sitter/pets-next-door-api/internal/domain/pet"
  "log"
  "net/http"
 
@@ -63,10 +64,14 @@ func addRoutes(r *chi.Mux, authService auth.AuthService) {
  postgres.NewPetPostgresStore(db),
  mediaService,
  )
+ breedService := pet.NewBreedService(
+ postgres.NewBreedPostgresStore(db),
+ )
 
  authHandler := handler.NewAuthHandler(authService, kakaoinfra.NewKakaoClient())
  userHandler := handler.NewUserHandler(userService, authService)
  mediaHandler := handler.NewMediaHandler(mediaService)
+ breedHandler := handler.NewBreedHandler(breedService)
 
  r.Get("/health", func(w http.ResponseWriter, r *http.Request) {
  w.Header().Set("Content-Type", "application/json")
@@ -94,5 +99,8 @@ func addRoutes(r *chi.Mux, authService auth.AuthService) {
  r.Get("/me/pets", userHandler.FindMyPets)
  r.Put("/me/pets", userHandler.AddMyPets)
  })
+ r.Route("/breeds", func(r chi.Router) {
+ r.Get("/", breedHandler.FindBreeds)
+ })
  })
 }
diff --git a/internal/configs/server.go b/internal/configs/server.go
@@ -54,7 +54,7 @@ var B2Endpoint = os.Getenv("B2_ENDPOINT")
 var B2Region = os.Getenv("B2_REGION")
 
 var GoogleSheetsAPIKey = os.Getenv("GOOGLE_SHEETS_API_KEY")
-var BreedsSheetsID = os.Getenv("BREEDS_SHEETS_ID")
+var BreedsGoogleSheetsID = os.Getenv("BREEDS_GOOGLE_SHEETS_ID")
 
 func init() {
  if Port == "" {

diff --git a/pkg/docs/docs.go b/pkg/docs/docs.go
@@ -1,5 +1,4 @@
-// Code generated by swaggo/swag. DO NOT EDIT.
-
+// Package docs Code generated by swaggo/swag. DO NOT EDIT
 package docs
 
 import "github.com/swaggo/swag"
@@ -54,6 +53,54 @@ const docTemplate = `{
  }
  }
  },
+ "/breeds": {
+ "get": {
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "pets"
+ ],
+ "summary": "견/묘종을 조회합니다.",
+ "parameters": [
+ {
+ "type": "integer",
+ "default": 1,
+ "description": "페이지 번호",
+ "name": "page",
+ "in": "query"
+ },
+ {
+ "type": "integer",
+ "default": 20,
+ "description": "페이지 사이즈",
+ "name": "size",
+ "in": "query"
+ },
+ {
+ "enum": [
+ "dog",
+ "cat"
+ ],
+ "type": "string",
+ "description": "펫 종류",
+ "name": "pet_type",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/commonviews.PaginatedView-pet_BreedView"
+ }
+ }
+ }
+ }
+ },
  "/media/images": {
  "post": {
  "consumes": [
@@ -320,6 +367,23 @@ const docTemplate = `{
  }
  }
  },
+ "commonviews.PaginatedView-pet_BreedView": {
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/pet.BreedView"
+ }
+ },
+ "page": {
+ "type": "integer"
+ },
+ "size": {
+ "type": "integer"
+ }
+ }
+ },
  "media.MediaType": {
  "type": "string",
  "enum": [
@@ -411,6 +475,20 @@ const docTemplate = `{
  }
  }
  },
+ "pet.BreedView": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "pet_type": {
+ "$ref": "#/definitions/pet.PetType"
+ }
+ }
+ },
  "pet.FindMyPetsView": {
  "type": "object",
  "properties": {

diff --git a/pkg/docs/swagger.json b/pkg/docs/swagger.json
@@ -46,6 +46,54 @@
  }
  }
  },
+ "/breeds": {
+ "get": {
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "pets"
+ ],
+ "summary": "견/묘종을 조회합니다.",
+ "parameters": [
+ {
+ "type": "integer",
+ "default": 1,
+ "description": "페이지 번호",
+ "name": "page",
+ "in": "query"
+ },
+ {
+ "type": "integer",
+ "default": 20,
+ "description": "페이지 사이즈",
+ "name": "size",
+ "in": "query"
+ },
+ {
+ "enum": [
+ "dog",
+ "cat"
+ ],
+ "type": "string",
+ "description": "펫 종류",
+ "name": "pet_type",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/commonviews.PaginatedView-pet_BreedView"
+ }
+ }
+ }
+ }
+ },
  "/media/images": {
  "post": {
  "consumes": [
@@ -312,6 +360,23 @@
  }
  }
  },
+ "commonviews.PaginatedView-pet_BreedView": {
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/pet.BreedView"
+ }
+ },
+ "page": {
+ "type": "integer"
+ },
+ "size": {
+ "type": "integer"
+ }
+ }
+ },
  "media.MediaType": {
  "type": "string",
  "enum": [
@@ -403,6 +468,20 @@
  }
  }
  },
+ "pet.BreedView": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "pet_type": {
+ "$ref": "#/definitions/pet.PetType"
+ }
+ }
+ },
  "pet.FindMyPetsView": {
  "type": "object",
  "properties": {