Kain344/History_Api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: implement battle replay controller, service, and routes with Swagger documentation
Build and Release / release (push) Successful in 3m2s
Details

Browse Source
This commit is contained in:
Azen Kain
2026-05-28 02:46:48 +07:00
parent 1d0733819d
commit 54b1522db5
7 changed files with 198 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs.go
+48
View File
@@ -450,6 +450,54 @@ const docTemplate = `{
}
}
},
"/battle-replays/geometries": {
"get": {
"description": "Get battle replays grouped by geometry IDs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"BattleReplays"
],
"summary": "Get battle replays by geometry IDs",
"parameters": [
{
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "geometry_ids",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/battle-replays/geometry/{geometryId}": {
"get": {
"description": "Get all battle replays associated with a specific geometry",
docs/swagger.json
+48
View File
@@ -443,6 +443,54 @@
}
}
},
"/battle-replays/geometries": {
"get": {
"description": "Get battle replays grouped by geometry IDs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"BattleReplays"
],
"summary": "Get battle replays by geometry IDs",
"parameters": [
{
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"name": "geometry_ids",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/history-api_internal_dtos_response.CommonResponse"
}
}
}
}
},
"/battle-replays/geometry/{geometryId}": {
"get": {
"description": "Get all battle replays associated with a specific geometry",
docs/swagger.yaml
+32
View File
@@ -1070,6 +1070,38 @@ paths:
summary: Get battle replay by ID
tags:
- BattleReplays
/battle-replays/geometries:
get:
consumes:
- application/json
description: Get battle replays grouped by geometry IDs
parameters:
- collectionFormat: csv
in: query
items:
type: string
minItems: 1
name: geometry_ids
required: true
type: array
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/history-api_internal_dtos_response.CommonResponse'
summary: Get battle replays by geometry IDs
tags:
- BattleReplays
/battle-replays/geometry/{geometryId}:
get:
consumes:
internal/controllers/battleReplayController.go
+39
View File
@@ -2,8 +2,10 @@ package controllers
import (
"context"
"history-api/internal/dtos/request"
"history-api/internal/dtos/response"
"history-api/internal/services"
"history-api/pkg/validator"
"time"
"github.com/gofiber/fiber/v3"
@@ -70,3 +72,40 @@ func (h *BattleReplayController) GetBattleReplaysByGeometryId(c fiber.Ctx) error
Data: res,
})
}
// GetBattleReplaysByGeometryIDs handles fetching battle replays by a list of geometry IDs.
// @Summary Get battle replays by geometry IDs
// @Description Get battle replays grouped by geometry IDs
// @Tags BattleReplays
// @Accept json
// @Produce json
// @Param query query request.GetBattleReplaysByGeometryIDsDto true "Query Parameters"
// @Success 200 {object} response.CommonResponse
// @Failure 400 {object} response.CommonResponse
// @Failure 500 {object} response.CommonResponse
// @Router /battle-replays/geometries [get]
func (h *BattleReplayController) GetBattleReplaysByGeometryIDs(c fiber.Ctx) error {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
dto := &request.GetBattleReplaysByGeometryIDsDto{}
if err := validator.ValidateQueryDto(c, dto); err != nil {
return c.Status(fiber.StatusBadRequest).JSON(response.CommonResponse{
Status: false,
Errors: err,
})
}
res, err := h.service.GetByGeometryIDs(ctx, dto)
if err != nil {
return c.Status(err.Code).JSON(response.CommonResponse{
Status: false,
Message: err.Message,
})
}
return c.Status(fiber.StatusOK).JSON(response.CommonResponse{
Status: true,
Data: res,
})
}
internal/dtos/request/battle_replay.go
+5
View File
@@ -0,0 +1,5 @@
package request
type GetBattleReplaysByGeometryIDsDto struct {
GeometryIDs []string `json:"geometry_ids" query:"geometry_ids" validate:"required,min=1,dive,uuid"`
}
internal/routes/battleReplayRoute.go
+1
View File
@@ -8,6 +8,7 @@ import (
func BattleReplayRoutes(router fiber.Router, battleReplayController *controllers.BattleReplayController) {
br := router.Group("/battle-replays")
br.Get("/geometries", battleReplayController.GetBattleReplaysByGeometryIDs)
br.Get("/geometry/:geometryId", battleReplayController.GetBattleReplaysByGeometryId)
br.Get("/:id", battleReplayController.GetBattleReplayById)
}
internal/services/battleReplayService.go
+25
View File
@@ -2,6 +2,7 @@ package services
import (
"context"
"history-api/internal/dtos/request"
"history-api/internal/dtos/response"
"history-api/internal/models"
"history-api/internal/repositories"
@@ -13,6 +14,7 @@ import (
type BattleReplayService interface {
GetByID(ctx context.Context, id string) (*response.BattleReplayResponse, *fiber.Error)
GetByGeometryID(ctx context.Context, geometryID string) ([]*response.BattleReplayResponse, *fiber.Error)
GetByGeometryIDs(ctx context.Context, req *request.GetBattleReplaysByGeometryIDsDto) (map[string][]*response.BattleReplayResponse, *fiber.Error)
}
type battleReplayService struct {
@@ -52,3 +54,26 @@ func (s *battleReplayService) GetByGeometryID(ctx context.Context, geometryID st
return models.BattleReplaysEntityToResponse(replays), nil
}
func (s *battleReplayService) GetByGeometryIDs(ctx context.Context, req *request.GetBattleReplaysByGeometryIDsDto) (map[string][]*response.BattleReplayResponse, *fiber.Error) {
replays, err := s.battleReplayRepo.GetByGeometryIDs(ctx, req.GeometryIDs)
if err != nil {
return nil, fiber.NewError(fiber.StatusInternalServerError, "Failed to get battle replays")
}
result := make(map[string][]*response.BattleReplayResponse)
for _, idStr := range req.GeometryIDs {
result[idStr] = make([]*response.BattleReplayResponse, 0)
}
for _, replay := range replays {
if replay != nil {
geomID := replay.GeometryID
if _, exists := result[geomID]; exists {
result[geomID] = append(result[geomID], replay.ToResponse())
}
}
}
return result, nil
}