{ "swagger": "2.0", "info": { "description": "API文档", "title": "组态接口文档", "contact": {}, "version": "1.0 版本" }, "basePath": "/app/scada/api/", "paths": { "/collection/count": { "post": { "description": "查询集合数量", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "collection" ], "summary": "查询集合数量", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/collection/create": { "post": { "description": "创建集合", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "collection" ], "summary": "创建集合", "parameters": [ { "description": "集合信息", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiCollection" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiCollection" } } } } }, "/collection/export": { "get": { "description": "导出集合", "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "tags": [ "product" ], "summary": "导出集合", "responses": {} } }, "/collection/import": { "post": { "description": "导入集合", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "product" ], "summary": "导入集合", "parameters": [ { "type": "file", "description": "压缩包", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/collection/list": { "get": { "description": "查询集合", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "collection" ], "summary": "查询集合", "parameters": [ { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "skip", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiCollection" } } } } }, "/collection/search": { "post": { "description": "查询集合", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "collection" ], "summary": "查询集合", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiCollection" } } } } }, "/collection/{id}": { "get": { "description": "获取集合", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "collection" ], "summary": "获取集合", "parameters": [ { "type": "integer", "description": "集合ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiCollection" } } } }, "post": { "description": "修改集合", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "collection" ], "summary": "修改集合", "parameters": [ { "type": "integer", "description": "集合ID", "name": "id", "in": "path", "required": true }, { "description": "集合信息", "name": "collection", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiCollection" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiCollection" } } } } }, "/collection/{id}/delete": { "get": { "description": "删除集合", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "collection" ], "summary": "删除集合", "parameters": [ { "type": "integer", "description": "集合ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiCollection" } } } } }, "/component/count": { "post": { "description": "查询组件数量", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "component" ], "summary": "查询组件数量", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/component/create": { "post": { "description": "创建组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "component" ], "summary": "创建组件", "parameters": [ { "description": "组件信息", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiComponent" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiComponent" } } } } }, "/component/export": { "get": { "description": "导出组件", "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "tags": [ "product" ], "summary": "导出组件", "responses": {} } }, "/component/import": { "post": { "description": "导入组件", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "product" ], "summary": "导入组件", "parameters": [ { "type": "file", "description": "压缩包", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/component/list": { "get": { "description": "查询组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "component" ], "summary": "查询组件", "parameters": [ { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "skip", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiComponent" } } } } }, "/component/search": { "post": { "description": "查询组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "component" ], "summary": "查询组件", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiComponent" } } } } }, "/component/{id}": { "get": { "description": "获取组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "component" ], "summary": "获取组件", "parameters": [ { "type": "integer", "description": "组件ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiComponent" } } } }, "post": { "description": "修改组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "component" ], "summary": "修改组件", "parameters": [ { "type": "integer", "description": "组件ID", "name": "id", "in": "path", "required": true }, { "description": "组件信息", "name": "component", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiComponent" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiComponent" } } } } }, "/component/{id}/delete": { "get": { "description": "删除组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "component" ], "summary": "删除组件", "parameters": [ { "type": "integer", "description": "组件ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiComponent" } } } } }, "/image/count": { "post": { "description": "查询图片组件数量", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "image" ], "summary": "查询图片组件数量", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/image/create": { "post": { "description": "创建图片组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "image" ], "summary": "创建图片组件", "parameters": [ { "description": "图片组件信息", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiImage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiImage" } } } } }, "/image/export": { "get": { "description": "导出图片组件", "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "tags": [ "product" ], "summary": "导出图片组件", "responses": {} } }, "/image/import": { "post": { "description": "导入图片组件", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "product" ], "summary": "导入图片组件", "parameters": [ { "type": "file", "description": "压缩包", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/image/list": { "get": { "description": "查询图片组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "image" ], "summary": "查询图片组件", "parameters": [ { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "skip", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiImage" } } } } }, "/image/search": { "post": { "description": "查询图片组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "image" ], "summary": "查询图片组件", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiImage" } } } } }, "/image/{id}": { "get": { "description": "获取图片组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "image" ], "summary": "获取图片组件", "parameters": [ { "type": "integer", "description": "图片组件ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiImage" } } } }, "post": { "description": "修改图片组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "image" ], "summary": "修改图片组件", "parameters": [ { "type": "integer", "description": "图片组件ID", "name": "id", "in": "path", "required": true }, { "description": "图片组件信息", "name": "image", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiImage" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiImage" } } } } }, "/image/{id}/delete": { "get": { "description": "删除图片组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "image" ], "summary": "删除图片组件", "parameters": [ { "type": "integer", "description": "图片组件ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiImage" } } } } }, "/path/count": { "post": { "description": "查询路径组件数量", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "path" ], "summary": "查询路径组件数量", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/path/create": { "post": { "description": "创建路径组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "path" ], "summary": "创建路径组件", "parameters": [ { "description": "路径组件信息", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiPath" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiPath" } } } } }, "/path/export": { "get": { "description": "导出路径组件", "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "tags": [ "product" ], "summary": "导出路径组件", "responses": {} } }, "/path/import": { "post": { "description": "导入路径组件", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "product" ], "summary": "导入路径组件", "parameters": [ { "type": "file", "description": "压缩包", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/path/list": { "get": { "description": "查询路径组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "path" ], "summary": "查询路径组件", "parameters": [ { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "skip", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiPath" } } } } }, "/path/search": { "post": { "description": "查询路径组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "path" ], "summary": "查询路径组件", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiPath" } } } } }, "/path/{id}": { "get": { "description": "获取路径组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "path" ], "summary": "获取路径组件", "parameters": [ { "type": "integer", "description": "路径组件ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiPath" } } } }, "post": { "description": "修改路径组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "path" ], "summary": "修改路径组件", "parameters": [ { "type": "integer", "description": "路径组件ID", "name": "id", "in": "path", "required": true }, { "description": "路径组件信息", "name": "path", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiPath" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiPath" } } } } }, "/path/{id}/delete": { "get": { "description": "删除路径组件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "path" ], "summary": "删除路径组件", "parameters": [ { "type": "integer", "description": "路径组件ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiPath" } } } } }, "/project/count": { "post": { "description": "查询工程数量", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "project" ], "summary": "查询工程数量", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/project/create": { "post": { "description": "创建工程", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "project" ], "summary": "创建工程", "parameters": [ { "description": "工程信息", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiProject" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiProject" } } } } }, "/project/export": { "get": { "description": "导出工程", "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "tags": [ "project" ], "summary": "导出工程", "responses": {} } }, "/project/import": { "post": { "description": "导入工程", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "project" ], "summary": "导入工程", "parameters": [ { "type": "file", "description": "压缩包", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-int64" } } } } }, "/project/list": { "get": { "description": "查询工程", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "project" ], "summary": "查询工程", "parameters": [ { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "skip", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiProject" } } } } }, "/project/search": { "post": { "description": "查询工程", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "project" ], "summary": "查询工程", "parameters": [ { "description": "查询参数", "name": "search", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.ParamSearch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyList-types_HmiProject" } } } } }, "/project/{id}": { "get": { "description": "获取工程", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "project" ], "summary": "获取工程", "parameters": [ { "type": "integer", "description": "工程ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiProject" } } } }, "post": { "description": "修改工程", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "project" ], "summary": "修改工程", "parameters": [ { "type": "integer", "description": "工程ID", "name": "id", "in": "path", "required": true }, { "description": "工程信息", "name": "project", "in": "body", "required": true, "schema": { "$ref": "#/definitions/types.HmiProject" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiProject" } } } } }, "/project/{id}/delete": { "get": { "description": "删除工程", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "project" ], "summary": "删除工程", "parameters": [ { "type": "integer", "description": "工程ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.ReplyData-types_HmiProject" } } } } } }, "definitions": { "api.ParamSearch": { "type": "object", "properties": { "filter": { "type": "object", "additionalProperties": true }, "keyword": { "type": "object", "additionalProperties": { "type": "string" } }, "limit": { "type": "integer" }, "skip": { "type": "integer" }, "sort": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "api.ReplyData-int64": { "type": "object", "properties": { "data": { "type": "integer" }, "error": { "type": "string" } } }, "api.ReplyData-types_HmiCollection": { "type": "object", "properties": { "data": { "$ref": "#/definitions/types.HmiCollection" }, "error": { "type": "string" } } }, "api.ReplyData-types_HmiComponent": { "type": "object", "properties": { "data": { "$ref": "#/definitions/types.HmiComponent" }, "error": { "type": "string" } } }, "api.ReplyData-types_HmiImage": { "type": "object", "properties": { "data": { "$ref": "#/definitions/types.HmiImage" }, "error": { "type": "string" } } }, "api.ReplyData-types_HmiPath": { "type": "object", "properties": { "data": { "$ref": "#/definitions/types.HmiPath" }, "error": { "type": "string" } } }, "api.ReplyData-types_HmiProject": { "type": "object", "properties": { "data": { "$ref": "#/definitions/types.HmiProject" }, "error": { "type": "string" } } }, "api.ReplyList-types_HmiCollection": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/types.HmiCollection" } }, "error": { "type": "string" }, "total": { "type": "integer" } } }, "api.ReplyList-types_HmiComponent": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/types.HmiComponent" } }, "error": { "type": "string" }, "total": { "type": "integer" } } }, "api.ReplyList-types_HmiImage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/types.HmiImage" } }, "error": { "type": "string" }, "total": { "type": "integer" } } }, "api.ReplyList-types_HmiPath": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/types.HmiPath" } }, "error": { "type": "string" }, "total": { "type": "integer" } } }, "api.ReplyList-types_HmiProject": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/types.HmiProject" } }, "error": { "type": "string" }, "total": { "type": "integer" } } }, "types.HmiCollection": { "type": "object", "properties": { "created": { "type": "string" }, "desc": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "types.HmiComponent": { "type": "object", "properties": { "bindings": { "type": "array", "items": { "$ref": "#/definitions/types.HmiComponentBinding" } }, "collection": { "type": "string" }, "created": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/definitions/types.HmiComponentEvent" } }, "icon": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object", "additionalProperties": {} }, "name": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/definitions/types.HmiProperty" } }, "type": { "type": "string" }, "updated": { "type": "string" }, "version": { "type": "integer" } } }, "types.HmiComponentBinding": { "type": "object", "properties": { "label": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "types.HmiComponentEvent": { "type": "object", "properties": { "label": { "type": "string" }, "name": { "type": "string" } } }, "types.HmiImage": { "type": "object", "properties": { "collection": { "type": "string" }, "created": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "updated": { "type": "string" }, "url": { "type": "string" } } }, "types.HmiPage": { "type": "object", "properties": { "background_color": { "type": "string" }, "background_image": { "type": "string" }, "content": {}, "name": { "type": "string" } } }, "types.HmiPath": { "type": "object", "properties": { "collection": { "type": "string" }, "created": { "type": "string" }, "icon": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "updated": { "type": "string" } } }, "types.HmiProject": { "type": "object", "properties": { "created": { "type": "string" }, "desc": { "type": "string" }, "height": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "pages": { "type": "array", "items": { "$ref": "#/definitions/types.HmiPage" } }, "updated": { "type": "string" }, "version": { "type": "integer" }, "width": { "type": "integer" } } }, "types.HmiProperty": { "type": "object", "properties": { "default": {}, "max": { "type": "integer" }, "min": { "type": "integer" }, "name": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/definitions/types.HmiPropertyOption" } }, "path": { "type": "string" }, "step": { "type": "integer" }, "type": { "type": "string" } } }, "types.HmiPropertyOption": { "type": "object", "properties": { "name": { "type": "string" }, "value": {} } } } }