调整swag
This commit is contained in:
@@ -1,11 +1,27 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"contact": {}
|
||||
"description": "这是一个用于管理猪场设备的后端服务。",
|
||||
"title": "猪场管理系统 API",
|
||||
"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": "1.0"
|
||||
},
|
||||
"paths": {
|
||||
"/api/v1/area-controllers": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "获取系统中所有区域主控的列表",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -39,6 +55,11 @@
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据提供的信息创建一个新区域主控",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -85,6 +106,11 @@
|
||||
},
|
||||
"/api/v1/area-controllers/{id}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据ID获取单个区域主控的详细信息",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -124,6 +150,11 @@
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据ID更新一个已存在的区域主控信息",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -175,6 +206,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据ID删除一个区域主控（软删除）",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -204,6 +240,11 @@
|
||||
},
|
||||
"/api/v1/device-templates": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "获取系统中所有设备模板的列表",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -237,6 +278,11 @@
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据提供的信息创建一个新设备模板",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -283,6 +329,11 @@
|
||||
},
|
||||
"/api/v1/device-templates/{id}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据设备模板ID获取单个设备模板的详细信息",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -322,6 +373,11 @@
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据设备模板ID更新一个已存在的设备模板信息",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -373,6 +429,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据设备模板ID删除一个设备模板（软删除）",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -402,6 +463,11 @@
|
||||
},
|
||||
"/api/v1/devices": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "获取系统中所有设备的列表",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -435,6 +501,11 @@
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据提供的信息创建一个新设备",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -481,6 +552,11 @@
|
||||
},
|
||||
"/api/v1/devices/manual-control/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据设备ID和指定的动作（开启或关闭）来手动控制设备",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -522,6 +598,11 @@
|
||||
},
|
||||
"/api/v1/devices/{id}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据设备ID获取单个设备的详细信息",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -561,6 +642,11 @@
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据设备ID更新一个已存在的设备信息",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -612,6 +698,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据设备ID删除一个设备（软删除）",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -641,6 +732,11 @@
|
||||
},
|
||||
"/api/v1/pens": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "获取所有猪栏的列表",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -674,6 +770,11 @@
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "创建一个新的猪栏",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -720,6 +821,11 @@
|
||||
},
|
||||
"/api/v1/pens/{id}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据ID获取单个猪栏信息",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -759,6 +865,11 @@
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "更新一个已存在的猪栏信息",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -810,6 +921,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据ID删除一个猪栏",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -839,6 +955,11 @@
|
||||
},
|
||||
"/api/v1/pens/{id}/status": {
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "更新指定猪栏的当前状态",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -892,6 +1013,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "获取所有猪批次的列表，支持按活跃状态筛选",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -933,6 +1059,11 @@
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "创建一个新的猪批次",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -979,6 +1110,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/assign-pens/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "将一个或多个空闲猪栏分配给指定的猪批次",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1020,6 +1156,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/buy-pigs/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "记录猪批次中的猪只购买事件",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1061,6 +1202,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/move-pigs-into-pen/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "将指定数量的猪只从批次的“虚拟库存”移入一个已分配的猪栏",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1102,6 +1248,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/reclassify-pen/{fromBatchID}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "将一个猪栏（连同其中的猪只）从一个批次整体划拨到另一个批次",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1143,6 +1294,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/record-cull/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "记录猪批次中正常猪只淘汰的数量和发生时间",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1184,6 +1340,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/record-death/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "记录猪批次中正常猪只死亡的数量和发生时间",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1225,6 +1386,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/record-sick-pig-cull/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "记录猪批次中病猪淘汰的数量、治疗地点和发生时间",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1266,6 +1432,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/record-sick-pig-death/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "记录猪批次中病猪死亡的数量、治疗地点和发生时间",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1307,6 +1478,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/record-sick-pig-recovery/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "记录猪批次中病猪康复的数量、治疗地点和发生时间",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1348,6 +1524,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/record-sick-pigs/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "记录猪批次中新增病猪的数量、治疗地点和发生时间",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1389,6 +1570,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/remove-pen/{penID}/{batchID}": {
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "将一个空闲猪栏从指定的猪批次中移除",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -1425,6 +1611,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/sell-pigs/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "记录猪批次中的猪只出售事件",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1466,6 +1657,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/transfer-across-batches/{sourceBatchID}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "将指定数量的猪只从一个猪群的猪栏调动到另一个猪群的猪栏",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1507,6 +1703,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/transfer-within-batch/{id}": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "将指定数量的猪只在同一个猪群的不同猪栏间调动",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1548,6 +1749,11 @@
|
||||
},
|
||||
"/api/v1/pig-batches/{id}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据ID获取单个猪批次信息",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -1587,6 +1793,11 @@
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "更新一个已存在的猪批次信息",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1638,6 +1849,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据ID删除一个猪批次",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -1667,6 +1883,11 @@
|
||||
},
|
||||
"/api/v1/pig-houses": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "获取所有猪舍的列表",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -1700,6 +1921,11 @@
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "创建一个新的猪舍",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1746,6 +1972,11 @@
|
||||
},
|
||||
"/api/v1/pig-houses/{id}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据ID获取单个猪舍信息",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -1785,6 +2016,11 @@
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "更新一个已存在的猪舍信息",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1836,6 +2072,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据ID删除一个猪舍",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -1865,6 +2106,11 @@
|
||||
},
|
||||
"/api/v1/plans": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "获取所有计划的列表",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -1898,6 +2144,11 @@
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "创建一个新的计划，包括其基本信息和所有关联的子计划/任务。",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -1944,6 +2195,11 @@
|
||||
},
|
||||
"/api/v1/plans/{id}": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据计划ID获取单个计划的详细信息。",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -1983,6 +2239,11 @@
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据计划ID更新计划的详细信息。",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
@@ -2034,6 +2295,11 @@
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据计划ID删除计划。（软删除）",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -2063,6 +2329,11 @@
|
||||
},
|
||||
"/api/v1/plans/{id}/start": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据计划ID启动一个计划的执行。",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -2092,6 +2363,11 @@
|
||||
},
|
||||
"/api/v1/plans/{id}/stop": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据计划ID停止一个正在执行的计划。",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -2213,6 +2489,11 @@
|
||||
},
|
||||
"/api/v1/users/{id}/history": {
|
||||
"get": {
|
||||
"security": [
|
||||
{
|
||||
"BearerAuth": []
|
||||
}
|
||||
],
|
||||
"description": "根据用户ID，分页获取该用户的操作审计日志。",
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -3848,5 +4129,12 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"securityDefinitions": {
|
||||
"BearerAuth": {
|
||||
"type": "apiKey",
|
||||
"name": "Authorization",
|
||||
"in": "header"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user