pig/pig-farm-controller
1
0
Fork 0
Code Issues 11 Pull Requests Actions Packages Projects Releases Wiki Activity

调整swag

Browse Source
This commit is contained in:
huang
2025-10-13 14:15:38 +08:00
parent 8c0dc6c815
commit bcec36f7e2
13 changed files with 760 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
internal/app/api/api.go
View File

@@ -8,6 +8,10 @@ package api
// @contact.email divano@example.com
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @securityDefinitions.apikey BearerAuth
// @in header
// @name Authorization
import (
"context"
"fmt"

16
internal/app/controller/device/device_controller.go
View File

@@ -48,6 +48,7 @@ func NewController(
// @Summary 创建新设备
// @Description 根据提供的信息创建一个新设备
// @Tags 设备管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param device body dto.CreateDeviceRequest true "设备信息"
@@ -111,6 +112,7 @@ func (c *Controller) CreateDevice(ctx *gin.Context) {
// @Summary 获取设备信息
// @Description 根据设备ID获取单个设备的详细信息
// @Tags 设备管理
// @Security BearerAuth
// @Produce json
// @Param id path string true "设备ID"
// @Success 200 {object} controller.Response{data=dto.DeviceResponse}
@@ -157,6 +159,7 @@ func (c *Controller) GetDevice(ctx *gin.Context) {
// @Summary 获取设备列表
// @Description 获取系统中所有设备的列表
// @Tags 设备管理
// @Security BearerAuth
// @Produce json
// @Success 200 {object} controller.Response{data=[]dto.DeviceResponse}
// @Router /api/v1/devices [get]
@@ -184,6 +187,7 @@ func (c *Controller) ListDevices(ctx *gin.Context) {
// @Summary 更新设备信息
// @Description 根据设备ID更新一个已存在的设备信息
// @Tags 设备管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path string true "设备ID"
@@ -265,6 +269,7 @@ func (c *Controller) UpdateDevice(ctx *gin.Context) {
// @Summary 删除设备
// @Description 根据设备ID删除一个设备（软删除）
// @Tags 设备管理
// @Security BearerAuth
// @Produce json
// @Param id path string true "设备ID"
// @Success 200 {object} controller.Response
@@ -306,6 +311,7 @@ func (c *Controller) DeleteDevice(ctx *gin.Context) {
// @Summary 手动控制设备
// @Description 根据设备ID和指定的动作（开启或关闭）来手动控制设备
// @Tags 设备管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path string true "设备ID"
@@ -369,6 +375,7 @@ func (c *Controller) ManualControl(ctx *gin.Context) {
// @Summary 创建新区域主控
// @Description 根据提供的信息创建一个新区域主控
// @Tags 区域主控管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param areaController body dto.CreateAreaControllerRequest true "区域主控信息"
@@ -424,6 +431,7 @@ func (c *Controller) CreateAreaController(ctx *gin.Context) {
// @Summary 获取区域主控信息
// @Description 根据ID获取单个区域主控的详细信息
// @Tags 区域主控管理
// @Security BearerAuth
// @Produce json
// @Param id path string true "区域主控ID"
// @Success 200 {object} controller.Response{data=dto.AreaControllerResponse}
@@ -466,6 +474,7 @@ func (c *Controller) GetAreaController(ctx *gin.Context) {
// @Summary 获取所有区域主控列表
// @Description 获取系统中所有区域主控的列表
// @Tags 区域主控管理
// @Security BearerAuth
// @Produce json
// @Success 200 {object} controller.Response{data=[]dto.AreaControllerResponse}
// @Router /api/v1/area-controllers [get]
@@ -493,6 +502,7 @@ func (c *Controller) ListAreaControllers(ctx *gin.Context) {
// @Summary 更新区域主控信息
// @Description 根据ID更新一个已存在的区域主控信息
// @Tags 区域主控管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path string true "区域主控ID"
@@ -568,6 +578,7 @@ func (c *Controller) UpdateAreaController(ctx *gin.Context) {
// @Summary 删除区域主控
// @Description 根据ID删除一个区域主控（软删除）
// @Tags 区域主控管理
// @Security BearerAuth
// @Produce json
// @Param id path string true "区域主控ID"
// @Success 200 {object} controller.Response
@@ -611,6 +622,7 @@ func (c *Controller) DeleteAreaController(ctx *gin.Context) {
// @Summary 创建新设备模板
// @Description 根据提供的信息创建一个新设备模板
// @Tags 设备模板管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param deviceTemplate body dto.CreateDeviceTemplateRequest true "设备模板信息"
@@ -675,6 +687,7 @@ func (c *Controller) CreateDeviceTemplate(ctx *gin.Context) {
// @Summary 获取设备模板信息
// @Description 根据设备模板ID获取单个设备模板的详细信息
// @Tags 设备模板管理
// @Security BearerAuth
// @Produce json
// @Param id path string true "设备模板ID"
// @Success 200 {object} controller.Response{data=dto.DeviceTemplateResponse}
@@ -717,6 +730,7 @@ func (c *Controller) GetDeviceTemplate(ctx *gin.Context) {
// @Summary 获取设备模板列表
// @Description 获取系统中所有设备模板的列表
// @Tags 设备模板管理
// @Security BearerAuth
// @Produce json
// @Success 200 {object} controller.Response{data=[]dto.DeviceTemplateResponse}
// @Router /api/v1/device-templates [get]
@@ -744,6 +758,7 @@ func (c *Controller) ListDeviceTemplates(ctx *gin.Context) {
// @Summary 更新设备模板信息
// @Description 根据设备模板ID更新一个已存在的设备模板信息
// @Tags 设备模板管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path string true "设备模板ID"
@@ -828,6 +843,7 @@ func (c *Controller) UpdateDeviceTemplate(ctx *gin.Context) {
// @Summary 删除设备模板
// @Description 根据设备模板ID删除一个设备模板（软删除）
// @Tags 设备模板管理
// @Security BearerAuth
// @Produce json
// @Param id path string true "设备模板ID"
// @Success 200 {object} controller.Response

9
internal/app/controller/management/pig_batch_controller.go
View File

@@ -28,6 +28,7 @@ func NewPigBatchController(logger *logs.Logger, service service.PigBatchService)
// @Summary 创建猪批次
// @Description 创建一个新的猪批次
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param body body dto.PigBatchCreateDTO true "猪批次信息"
@@ -52,6 +53,7 @@ func (c *PigBatchController) CreatePigBatch(ctx *gin.Context) {
// @Summary 获取单个猪批次
// @Description 根据ID获取单个猪批次信息
// @Tags 猪群管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "猪批次ID"
// @Success 200 {object} controller.Response{data=dto.PigBatchResponseDTO} "获取成功"
@@ -73,6 +75,7 @@ func (c *PigBatchController) GetPigBatch(ctx *gin.Context) {
// @Summary 更新猪批次
// @Description 更新一个已存在的猪批次信息
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"
@@ -97,6 +100,7 @@ func (c *PigBatchController) UpdatePigBatch(ctx *gin.Context) {
// @Summary 删除猪批次
// @Description 根据ID删除一个猪批次
// @Tags 猪群管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "猪批次ID"
// @Success 200 {object} controller.Response "删除成功"
@@ -118,6 +122,7 @@ func (c *PigBatchController) DeletePigBatch(ctx *gin.Context) {
// @Summary 获取猪批次列表
// @Description 获取所有猪批次的列表，支持按活跃状态筛选
// @Tags 猪群管理
// @Security BearerAuth
// @Produce json
// @Param is_active query bool false "是否活跃 (true/false)"
// @Success 200 {object} controller.Response{data=[]dto.PigBatchResponseDTO} "获取成功"
@@ -139,6 +144,7 @@ func (c *PigBatchController) ListPigBatches(ctx *gin.Context) {
// @Summary 为猪批次分配空栏
// @Description 将一个或多个空闲猪栏分配给指定的猪批次
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"
@@ -163,6 +169,7 @@ func (c *PigBatchController) AssignEmptyPensToBatch(ctx *gin.Context) {
// @Summary 将猪栏划拨到新批次
// @Description 将一个猪栏（连同其中的猪只）从一个批次整体划拨到另一个批次
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param fromBatchID path int true "源猪批次ID"
@@ -195,6 +202,7 @@ func (c *PigBatchController) ReclassifyPenToNewBatch(ctx *gin.Context) {
// @Summary 从猪批次移除空栏
// @Description 将一个空闲猪栏从指定的猪批次中移除
// @Tags 猪群管理
// @Security BearerAuth
// @Produce json
// @Param batchID path int true "猪批次ID"
// @Param penID path int true "待移除的猪栏ID"
@@ -230,6 +238,7 @@ func (c *PigBatchController) RemoveEmptyPenFromBatch(ctx *gin.Context) {
// @Summary 将猪只从“虚拟库存”移入指定猪栏
// @Description 将指定数量的猪只从批次的“虚拟库存”移入一个已分配的猪栏
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"

6
internal/app/controller/management/pig_batch_health_controller.go
View File

@@ -9,6 +9,7 @@ import (
// @Summary 记录新增病猪事件
// @Description 记录猪批次中新增病猪的数量、治疗地点和发生时间
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"
@@ -33,6 +34,7 @@ func (c *PigBatchController) RecordSickPigs(ctx *gin.Context) {
// @Summary 记录病猪康复事件
// @Description 记录猪批次中病猪康复的数量、治疗地点和发生时间
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"
@@ -57,6 +59,7 @@ func (c *PigBatchController) RecordSickPigRecovery(ctx *gin.Context) {
// @Summary 记录病猪死亡事件
// @Description 记录猪批次中病猪死亡的数量、治疗地点和发生时间
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"
@@ -81,6 +84,7 @@ func (c *PigBatchController) RecordSickPigDeath(ctx *gin.Context) {
// @Summary 记录病猪淘汰事件
// @Description 记录猪批次中病猪淘汰的数量、治疗地点和发生时间
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"
@@ -105,6 +109,7 @@ func (c *PigBatchController) RecordSickPigCull(ctx *gin.Context) {
// @Summary 记录正常猪只死亡事件
// @Description 记录猪批次中正常猪只死亡的数量和发生时间
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"
@@ -129,6 +134,7 @@ func (c *PigBatchController) RecordDeath(ctx *gin.Context) {
// @Summary 记录正常猪只淘汰事件
// @Description 记录猪批次中正常猪只淘汰的数量和发生时间
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"

2
internal/app/controller/management/pig_batch_trade_controller.go
View File

@@ -9,6 +9,7 @@ import (
// @Summary 处理卖猪的业务逻辑
// @Description 记录猪批次中的猪只出售事件
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"
@@ -33,6 +34,7 @@ func (c *PigBatchController) SellPigs(ctx *gin.Context) {
// @Summary 处理买猪的业务逻辑
// @Description 记录猪批次中的猪只购买事件
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"

2
internal/app/controller/management/pig_batch_transfer_controller.go
View File

@@ -11,6 +11,7 @@ import (
// @Summary 跨猪群调栏
// @Description 将指定数量的猪只从一个猪群的猪栏调动到另一个猪群的猪栏
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param sourceBatchID path int true "源猪批次ID"
@@ -43,6 +44,7 @@ func (c *PigBatchController) TransferPigsAcrossBatches(ctx *gin.Context) {
// @Summary 群内调栏
// @Description 将指定数量的猪只在同一个猪群的不同猪栏间调动
// @Tags 猪群管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪批次ID"

11
internal/app/controller/management/pig_farm_controller.go
View File

@@ -33,6 +33,7 @@ func NewPigFarmController(logger *logs.Logger, service service.PigFarmService) *
// @Summary 创建猪舍
// @Description 创建一个新的猪舍
// @Tags 猪场管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param body body dto.CreatePigHouseRequest true "猪舍信息"
@@ -65,6 +66,7 @@ func (c *PigFarmController) CreatePigHouse(ctx *gin.Context) {
// @Summary 获取单个猪舍
// @Description 根据ID获取单个猪舍信息
// @Tags 猪场管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "猪舍ID"
// @Success 200 {object} controller.Response{data=dto.PigHouseResponse} "获取成功"
@@ -100,6 +102,7 @@ func (c *PigFarmController) GetPigHouse(ctx *gin.Context) {
// @Summary 获取猪舍列表
// @Description 获取所有猪舍的列表
// @Tags 猪场管理
// @Security BearerAuth
// @Produce json
// @Success 200 {object} controller.Response{data=[]dto.PigHouseResponse} "获取成功"
// @Router /api/v1/pig-houses [get]
@@ -128,6 +131,7 @@ func (c *PigFarmController) ListPigHouses(ctx *gin.Context) {
// @Summary 更新猪舍
// @Description 更新一个已存在的猪舍信息
// @Tags 猪场管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪舍ID"
@@ -171,6 +175,7 @@ func (c *PigFarmController) UpdatePigHouse(ctx *gin.Context) {
// @Summary 删除猪舍
// @Description 根据ID删除一个猪舍
// @Tags 猪场管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "猪舍ID"
// @Success 200 {object} controller.Response "删除成功"
@@ -207,6 +212,7 @@ func (c *PigFarmController) DeletePigHouse(ctx *gin.Context) {
// @Summary 创建猪栏
// @Description 创建一个新的猪栏
// @Tags 猪场管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param body body dto.CreatePenRequest true "猪栏信息"
@@ -247,6 +253,7 @@ func (c *PigFarmController) CreatePen(ctx *gin.Context) {
// @Summary 获取单个猪栏
// @Description 根据ID获取单个猪栏信息
// @Tags 猪场管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "猪栏ID"
// @Success 200 {object} controller.Response{data=dto.PenResponse} "获取成功"
@@ -285,6 +292,7 @@ func (c *PigFarmController) GetPen(ctx *gin.Context) {
// @Summary 获取猪栏列表
// @Description 获取所有猪栏的列表
// @Tags 猪场管理
// @Security BearerAuth
// @Produce json
// @Success 200 {object} controller.Response{data=[]dto.PenResponse} "获取成功"
// @Router /api/v1/pens [get]
@@ -316,6 +324,7 @@ func (c *PigFarmController) ListPens(ctx *gin.Context) {
// @Summary 更新猪栏
// @Description 更新一个已存在的猪栏信息
// @Tags 猪场管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪栏ID"
@@ -363,6 +372,7 @@ func (c *PigFarmController) UpdatePen(ctx *gin.Context) {
// @Summary 删除猪栏
// @Description 根据ID删除一个猪栏
// @Tags 猪场管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "猪栏ID"
// @Success 200 {object} controller.Response "删除成功"
@@ -397,6 +407,7 @@ func (c *PigFarmController) DeletePen(ctx *gin.Context) {
// @Summary 更新猪栏状态
// @Description 更新指定猪栏的当前状态
// @Tags 猪场管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "猪栏ID"

7
internal/app/controller/plan/plan_controller.go
View File

@@ -38,6 +38,7 @@ func NewController(logger *logs.Logger, planRepo repository.PlanRepository, anal
// @Summary 创建计划
// @Description 创建一个新的计划，包括其基本信息和所有关联的子计划/任务。
// @Tags 计划管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param plan body dto.CreatePlanRequest true "计划信息"
@@ -98,6 +99,7 @@ func (c *Controller) CreatePlan(ctx *gin.Context) {
// @Summary 获取计划详情
// @Description 根据计划ID获取单个计划的详细信息。
// @Tags 计划管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "计划ID"
// @Success 200 {object} controller.Response{data=dto.PlanResponse} "业务码为200代表成功获取"
@@ -145,6 +147,7 @@ func (c *Controller) GetPlan(ctx *gin.Context) {
// @Summary 获取计划列表
// @Description 获取所有计划的列表
// @Tags 计划管理
// @Security BearerAuth
// @Produce json
// @Success 200 {object} controller.Response{data=[]dto.PlanResponse} "业务码为200代表成功获取列表"
// @Router /api/v1/plans [get]
@@ -183,6 +186,7 @@ func (c *Controller) ListPlans(ctx *gin.Context) {
// @Summary 更新计划
// @Description 根据计划ID更新计划的详细信息。
// @Tags 计划管理
// @Security BearerAuth
// @Accept json
// @Produce json
// @Param id path int true "计划ID"
@@ -280,6 +284,7 @@ func (c *Controller) UpdatePlan(ctx *gin.Context) {
// @Summary 删除计划
// @Description 根据计划ID删除计划。（软删除）
// @Tags 计划管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "计划ID"
// @Success 200 {object} controller.Response "业务码为200代表删除成功"
@@ -333,6 +338,7 @@ func (c *Controller) DeletePlan(ctx *gin.Context) {
// @Summary 启动计划
// @Description 根据计划ID启动一个计划的执行。
// @Tags 计划管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "计划ID"
// @Success 200 {object} controller.Response "业务码为200代表成功启动计划"
@@ -412,6 +418,7 @@ func (c *Controller) StartPlan(ctx *gin.Context) {
// @Summary 停止计划
// @Description 根据计划ID停止一个正在执行的计划。
// @Tags 计划管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "计划ID"
// @Success 200 {object} controller.Response "业务码为200代表成功停止计划"

1
internal/app/controller/user/user_controller.go
View File

@@ -130,6 +130,7 @@ func (c *Controller) Login(ctx *gin.Context) {
// @Summary 获取指定用户的操作历史
// @Description 根据用户ID，分页获取该用户的操作审计日志。
// @Tags 用户管理
// @Security BearerAuth
// @Produce json
// @Param id path int true "用户ID"
// @Param page query int false "页码" default(1)