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

293
docs/docs.go
View File

@@ -9,7 +9,15 @@ const docTemplate = `{
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {},
"contact": {
"name": "Divano",
"url": "http://www.example.com",
"email": "divano@example.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
@@ -17,6 +25,11 @@ const docTemplate = `{
"paths": {
"/api/v1/area-controllers": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "获取系统中所有区域主控的列表",
"produces": [
"application/json"
@@ -50,6 +63,11 @@ const docTemplate = `{
}
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据提供的信息创建一个新区域主控",
"consumes": [
"application/json"
@@ -96,6 +114,11 @@ const docTemplate = `{
},
"/api/v1/area-controllers/{id}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据ID获取单个区域主控的详细信息",
"produces": [
"application/json"
@@ -135,6 +158,11 @@ const docTemplate = `{
}
},
"put": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据ID更新一个已存在的区域主控信息",
"consumes": [
"application/json"
@@ -186,6 +214,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据ID删除一个区域主控（软删除）",
"produces": [
"application/json"
@@ -215,6 +248,11 @@ const docTemplate = `{
},
"/api/v1/device-templates": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "获取系统中所有设备模板的列表",
"produces": [
"application/json"
@@ -248,6 +286,11 @@ const docTemplate = `{
}
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据提供的信息创建一个新设备模板",
"consumes": [
"application/json"
@@ -294,6 +337,11 @@ const docTemplate = `{
},
"/api/v1/device-templates/{id}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据设备模板ID获取单个设备模板的详细信息",
"produces": [
"application/json"
@@ -333,6 +381,11 @@ const docTemplate = `{
}
},
"put": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据设备模板ID更新一个已存在的设备模板信息",
"consumes": [
"application/json"
@@ -384,6 +437,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据设备模板ID删除一个设备模板（软删除）",
"produces": [
"application/json"
@@ -413,6 +471,11 @@ const docTemplate = `{
},
"/api/v1/devices": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "获取系统中所有设备的列表",
"produces": [
"application/json"
@@ -446,6 +509,11 @@ const docTemplate = `{
}
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据提供的信息创建一个新设备",
"consumes": [
"application/json"
@@ -492,6 +560,11 @@ const docTemplate = `{
},
"/api/v1/devices/manual-control/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据设备ID和指定的动作（开启或关闭）来手动控制设备",
"consumes": [
"application/json"
@@ -533,6 +606,11 @@ const docTemplate = `{
},
"/api/v1/devices/{id}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据设备ID获取单个设备的详细信息",
"produces": [
"application/json"
@@ -572,6 +650,11 @@ const docTemplate = `{
}
},
"put": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据设备ID更新一个已存在的设备信息",
"consumes": [
"application/json"
@@ -623,6 +706,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据设备ID删除一个设备（软删除）",
"produces": [
"application/json"
@@ -652,6 +740,11 @@ const docTemplate = `{
},
"/api/v1/pens": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "获取所有猪栏的列表",
"produces": [
"application/json"
@@ -685,6 +778,11 @@ const docTemplate = `{
}
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "创建一个新的猪栏",
"consumes": [
"application/json"
@@ -731,6 +829,11 @@ const docTemplate = `{
},
"/api/v1/pens/{id}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据ID获取单个猪栏信息",
"produces": [
"application/json"
@@ -770,6 +873,11 @@ const docTemplate = `{
}
},
"put": {
"security": [
{
"BearerAuth": []
}
],
"description": "更新一个已存在的猪栏信息",
"consumes": [
"application/json"
@@ -821,6 +929,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据ID删除一个猪栏",
"produces": [
"application/json"
@@ -850,6 +963,11 @@ const docTemplate = `{
},
"/api/v1/pens/{id}/status": {
"put": {
"security": [
{
"BearerAuth": []
}
],
"description": "更新指定猪栏的当前状态",
"consumes": [
"application/json"
@@ -903,6 +1021,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "获取所有猪批次的列表，支持按活跃状态筛选",
"produces": [
"application/json"
@@ -944,6 +1067,11 @@ const docTemplate = `{
}
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "创建一个新的猪批次",
"consumes": [
"application/json"
@@ -990,6 +1118,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/assign-pens/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "将一个或多个空闲猪栏分配给指定的猪批次",
"consumes": [
"application/json"
@@ -1031,6 +1164,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/buy-pigs/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "记录猪批次中的猪只购买事件",
"consumes": [
"application/json"
@@ -1072,6 +1210,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/move-pigs-into-pen/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "将指定数量的猪只从批次的“虚拟库存”移入一个已分配的猪栏",
"consumes": [
"application/json"
@@ -1113,6 +1256,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/reclassify-pen/{fromBatchID}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "将一个猪栏（连同其中的猪只）从一个批次整体划拨到另一个批次",
"consumes": [
"application/json"
@@ -1154,6 +1302,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/record-cull/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "记录猪批次中正常猪只淘汰的数量和发生时间",
"consumes": [
"application/json"
@@ -1195,6 +1348,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/record-death/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "记录猪批次中正常猪只死亡的数量和发生时间",
"consumes": [
"application/json"
@@ -1236,6 +1394,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/record-sick-pig-cull/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "记录猪批次中病猪淘汰的数量、治疗地点和发生时间",
"consumes": [
"application/json"
@@ -1277,6 +1440,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/record-sick-pig-death/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "记录猪批次中病猪死亡的数量、治疗地点和发生时间",
"consumes": [
"application/json"
@@ -1318,6 +1486,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/record-sick-pig-recovery/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "记录猪批次中病猪康复的数量、治疗地点和发生时间",
"consumes": [
"application/json"
@@ -1359,6 +1532,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/record-sick-pigs/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "记录猪批次中新增病猪的数量、治疗地点和发生时间",
"consumes": [
"application/json"
@@ -1400,6 +1578,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/remove-pen/{penID}/{batchID}": {
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "将一个空闲猪栏从指定的猪批次中移除",
"produces": [
"application/json"
@@ -1436,6 +1619,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/sell-pigs/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "记录猪批次中的猪只出售事件",
"consumes": [
"application/json"
@@ -1477,6 +1665,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/transfer-across-batches/{sourceBatchID}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "将指定数量的猪只从一个猪群的猪栏调动到另一个猪群的猪栏",
"consumes": [
"application/json"
@@ -1518,6 +1711,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/transfer-within-batch/{id}": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "将指定数量的猪只在同一个猪群的不同猪栏间调动",
"consumes": [
"application/json"
@@ -1559,6 +1757,11 @@ const docTemplate = `{
},
"/api/v1/pig-batches/{id}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据ID获取单个猪批次信息",
"produces": [
"application/json"
@@ -1598,6 +1801,11 @@ const docTemplate = `{
}
},
"put": {
"security": [
{
"BearerAuth": []
}
],
"description": "更新一个已存在的猪批次信息",
"consumes": [
"application/json"
@@ -1649,6 +1857,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据ID删除一个猪批次",
"produces": [
"application/json"
@@ -1678,6 +1891,11 @@ const docTemplate = `{
},
"/api/v1/pig-houses": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "获取所有猪舍的列表",
"produces": [
"application/json"
@@ -1711,6 +1929,11 @@ const docTemplate = `{
}
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "创建一个新的猪舍",
"consumes": [
"application/json"
@@ -1757,6 +1980,11 @@ const docTemplate = `{
},
"/api/v1/pig-houses/{id}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据ID获取单个猪舍信息",
"produces": [
"application/json"
@@ -1796,6 +2024,11 @@ const docTemplate = `{
}
},
"put": {
"security": [
{
"BearerAuth": []
}
],
"description": "更新一个已存在的猪舍信息",
"consumes": [
"application/json"
@@ -1847,6 +2080,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据ID删除一个猪舍",
"produces": [
"application/json"
@@ -1876,6 +2114,11 @@ const docTemplate = `{
},
"/api/v1/plans": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "获取所有计划的列表",
"produces": [
"application/json"
@@ -1909,6 +2152,11 @@ const docTemplate = `{
}
},
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "创建一个新的计划，包括其基本信息和所有关联的子计划/任务。",
"consumes": [
"application/json"
@@ -1955,6 +2203,11 @@ const docTemplate = `{
},
"/api/v1/plans/{id}": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据计划ID获取单个计划的详细信息。",
"produces": [
"application/json"
@@ -1994,6 +2247,11 @@ const docTemplate = `{
}
},
"put": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据计划ID更新计划的详细信息。",
"consumes": [
"application/json"
@@ -2045,6 +2303,11 @@ const docTemplate = `{
}
},
"delete": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据计划ID删除计划。（软删除）",
"produces": [
"application/json"
@@ -2074,6 +2337,11 @@ const docTemplate = `{
},
"/api/v1/plans/{id}/start": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据计划ID启动一个计划的执行。",
"produces": [
"application/json"
@@ -2103,6 +2371,11 @@ const docTemplate = `{
},
"/api/v1/plans/{id}/stop": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据计划ID停止一个正在执行的计划。",
"produces": [
"application/json"
@@ -2224,6 +2497,11 @@ const docTemplate = `{
},
"/api/v1/users/{id}/history": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "根据用户ID，分页获取该用户的操作审计日志。",
"produces": [
"application/json"
@@ -3859,17 +4137,24 @@ const docTemplate = `{
}
}
}
},
"securityDefinitions": {
"BearerAuth": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "",
Version: "1.0",
Host: "",
BasePath: "",
Schemes: []string{},
Title: "",
Description: "",
Title: "猪场管理系统 API",
Description: "这是一个用于管理猪场设备的后端服务。",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",