working-hours-platform/api.json

{
  "swagger": "2.0",
  "info": {
    "description": "禅道 dev 禅道管理后台",
    "version": "1.0",
    "title": "禅道 dev 禅道管理后台"
  },
  "host": "192.168.0.135:8085",
  "basePath": "/",
  "tags": [{
    "name": "个人使用",
    "description": "Personal Controller"
  }, {
    "name": "财务使用",
    "description": "Finance Controller"
  }, {
    "name": "部门使用",
    "description": "Dept Controller"
  }],
  "paths": {
    "/api/dept/byDetail": {
      "post": {
        "tags": ["部门使用"],
        "summary": "月详情（date:当月日期：yyyy-MM-dd",
        "operationId": "byDetailUsingPOST",
        "consumes": ["application/json"],
        "produces": ["*/*"],
        "parameters": [{
          "in": "body",
          "name": "param",
          "description": "param",
          "required": true,
          "schema": {
            "originalRef": "DeptPageDto",
            "$ref": "#/definitions/DeptPageDto"
          }
        }],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result«DetailVo»",
              "$ref": "#/definitions/Result«DetailVo»"
            }
          },
          "201": {
            "description": "Created"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    },
    "/api/dept/byMonth": {
      "post": {
        "tags": ["部门使用"],
        "summary": "月统计（date:当月日期：yyyy-MM-dd）",
        "operationId": "byMonthUsingPOST",
        "consumes": ["application/json"],
        "produces": ["*/*"],
        "parameters": [{
          "in": "body",
          "name": "param",
          "description": "param",
          "required": true,
          "schema": {
            "originalRef": "DeptPageDto",
            "$ref": "#/definitions/DeptPageDto"
          }
        }],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result«MonthVo»",
              "$ref": "#/definitions/Result«MonthVo»"
            }
          },
          "201": {
            "description": "Created"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    },
    "/api/dept/excelByDetail": {
      "post": {
        "tags": ["部门使用"],
        "summary": "月详情(excel)（date:当月日期：yyyy-MM-dd",
        "operationId": "excelByDetailUsingPOST",
        "consumes": ["application/json"],
        "produces": ["*/*"],
        "parameters": [{
          "in": "body",
          "name": "param",
          "description": "param",
          "required": true,
          "schema": {
            "originalRef": "DeptDto",
            "$ref": "#/definitions/DeptDto"
          }
        }],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result«DetailVo»",
              "$ref": "#/definitions/Result«DetailVo»"
            }
          },
          "201": {
            "description": "Created"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    },
    "/api/dept/excelByMonth": {
      "post": {
        "tags": ["部门使用"],
        "summary": "月统计(excel)（date:当月日期：yyyy-MM-dd）",
        "operationId": "excelByMonthUsingPOST",
        "consumes": ["application/json"],
        "produces": ["*/*"],
        "parameters": [{
          "in": "body",
          "name": "param",
          "description": "param",
          "required": true,
          "schema": {
            "originalRef": "DeptDto",
            "$ref": "#/definitions/DeptDto"
          }
        }],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result«MonthVo»",
              "$ref": "#/definitions/Result«MonthVo»"
            }
          },
          "201": {
            "description": "Created"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    },
    "/api/dept/list": {
      "get": {
        "tags": ["部门使用"],
        "summary": "部门列表",
        "operationId": "listUsingGET",
        "produces": ["*/*"],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result",
              "$ref": "#/definitions/Result"
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    },
    "/api/finance/excelByDetail/{date}": {
      "get": {
        "tags": ["财务使用"],
        "summary": "月详情（date:当月日期：yyyy-MM-dd）",
        "operationId": "excelByDetailUsingGET",
        "produces": ["*/*"],
        "parameters": [{
          "name": "date",
          "in": "path",
          "description": "date",
          "required": true,
          "type": "string"
        }],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result«DetailVo»",
              "$ref": "#/definitions/Result«DetailVo»"
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    },



    "/api/finance/excelByMonth/{date}": {
      "get": {
        "tags": ["财务使用"],
        "summary": "月总计（date:当月日期：yyyy-MM-dd）",
        "operationId": "excelByMonthUsingGET",
        "produces": ["*/*"],
        "parameters": [{
          "name": "date",
          "in": "path",
          "description": "date",
          "required": true,
          "type": "string"
        }],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result«FinanceMonthVo»",
              "$ref": "#/definitions/Result«FinanceMonthVo»"
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    },
    "/api/personal/getUserList": {
      "get": {
        "tags": ["个人使用"],
        "summary": "用户列表",
        "operationId": "getUserListUsingGET",
        "produces": ["*/*"],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result",
              "$ref": "#/definitions/Result"
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    },
    "/api/personal/workByMonth/{account}/{date}": {
      "get": {
        "tags": ["个人使用"],
        "summary": "月统计（date:当月日期：yyyy-MM-dd）",
        "operationId": "workByMonthUsingGET",
        "produces": ["*/*"],
        "parameters": [{
          "name": "account",
          "in": "path",
          "description": "account",
          "required": true,
          "type": "string"
        }, {
          "name": "date",
          "in": "path",
          "description": "date",
          "required": true,
          "type": "string"
        }],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result",
              "$ref": "#/definitions/Result"
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    },
    "/api/personal/workByMonthDetail": {
      "post": {
        "tags": ["个人使用"],
        "summary": "月详情（date:当月日期：yyyy-MM-dd）",
        "description": "多参数查询工时",
        "operationId": "effortByMonthExcelUsingPOST",
        "consumes": ["application/json"],
        "produces": ["*/*"],
        "parameters": [{
          "in": "body",
          "name": "param",
          "description": "param",
          "required": true,
          "schema": {
            "originalRef": "PersonalPageDto",
            "$ref": "#/definitions/PersonalPageDto"
          }
        }],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "originalRef": "Result«DetailVo»",
              "$ref": "#/definitions/Result«DetailVo»"
            }
          },
          "201": {
            "description": "Created"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },
        "security": [{
          "Authorization": ["global"]
        }],
        "deprecated": false,
        "x-order": "2147483647"
      }
    }
  },
  "securityDefinitions": {
    "Authorization": {
      "type": "apiKey",
      "name": "token",
      "in": "header"
    }
  },
  "definitions": {
    "DeptDto": {
      "type": "object",
      "required": ["date", "deptId"],
      "properties": {
        "date": {
          "type": "string",
          "description": "日期,yyyy-MM-dd"
        },
        "deptId": {
          "type": "string",
          "description": "部门id"
        }
      },
      "title": "DeptDto"
    },
    "DeptPageDto": {
      "type": "object",
      "required": ["date", "deptId"],
      "properties": {
        "date": {
          "type": "string",
          "description": "日期,yyyy-MM-dd"
        },
        "deptId": {
          "type": "string",
          "description": "部门id"
        },
        "pageNum": {
          "type": "integer",
          "format": "int32",
          "description": "起始页码，默认0为第一页"
        },
        "pageSize": {
          "type": "integer",
          "format": "int32",
          "description": "每页数量"
        },
        "searchKey": {
          "type": "string",
          "description": "搜索条件"
        }
      },
      "title": "DeptPageDto"
    },
    "DetailVo": {
      "type": "object",
      "properties": {
        "account": {
          "type": "string",
          "description": "账号"
        },
        "code": {
          "type": "string",
          "description": "项目号"
        },
        "consumed": {
          "type": "string",
          "description": "消耗时间, 单位是小时"
        },
        "date": {
          "type": "string",
          "format": "date-time",
          "description": "日期"
        },
        "deptId": {
          "type": "string",
          "description": "部门id"
        },
        "deptName": {
          "type": "string",
          "description": "部门名称"
        },
        "project": {
          "type": "integer",
          "format": "int32",
          "description": "项目id"
        },
        "projectName": {
          "type": "string",
          "description": "项目名称"
        },
        "realname": {
          "type": "string",
          "description": "真实姓名"
        },
        "slack": {
          "type": "string",
          "description": "工号"
        },
        "task": {
          "type": "string",
          "description": "任务号"
        }
      },
      "title": "DetailVo"
    },
    "FinanceMonthVo": {
      "type": "object",
      "properties": {
        "account": {
          "type": "string",
          "description": "账号"
        },
        "code": {
          "type": "string",
          "description": "项目号"
        },
        "consumed": {
          "type": "string",
          "description": "消耗时间, 单位是天"
        },
        "deptName": {
          "type": "string",
          "description": "部门名称"
        },
        "projectName": {
          "type": "string",
          "description": "项目名称"
        },
        "realname": {
          "type": "string",
          "description": "真实姓名"
        },
        "slack": {
          "type": "string",
          "description": "工号"
        },
        "task": {
          "type": "string",
          "description": "任务号"
        }
      },
      "title": "FinanceMonthVo"
    },
    "MonthVo": {
      "type": "object",
      "properties": {
        "account": {
          "type": "string",
          "description": "账号"
        },
        "consumed": {
          "type": "string",
          "description": "消耗时间, 单位是天"
        },
        "date": {
          "type": "string",
          "format": "date-time",
          "description": "日期"
        },
        "deptName": {
          "type": "string",
          "description": "部门名称"
        },
        "realname": {
          "type": "string",
          "description": "真实姓名"
        }
      },
      "title": "MonthVo"
    },
    "PersonalPageDto": {
      "type": "object",
      "required": ["date"],
      "properties": {
        "account": {
          "type": "string",
          "description": "账号"
        },
        "date": {
          "type": "string",
          "description": "日期,yyyy-MM-dd"
        },
        "pageNum": {
          "type": "integer",
          "format": "int32",
          "description": "起始页码，默认0为第一页"
        },
        "pageSize": {
          "type": "integer",
          "format": "int32",
          "description": "每页数量"
        },
        "searchKey": {
          "type": "string",
          "description": "搜索条件"
        }
      },
      "title": "PersonalPageDto"
    },
    "Result": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "处理状态：0: 成功, 1: 失败"
        },
        "data": {
          "type": "object",
          "description": "返回数据"
        },
        "msg": {
          "type": "string",
          "description": "消息"
        }
      },
      "title": "Result"
    },
    "Result«DetailVo»": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "处理状态：0: 成功, 1: 失败"
        },
        "data": {
          "description": "返回数据",
          "originalRef": "DetailVo",
          "$ref": "#/definitions/DetailVo"
        },
        "msg": {
          "type": "string",
          "description": "消息"
        }
      },
      "title": "Result«DetailVo»"
    },
    "Result«FinanceMonthVo»": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "处理状态：0: 成功, 1: 失败"
        },
        "data": {
          "description": "返回数据",
          "originalRef": "FinanceMonthVo",
          "$ref": "#/definitions/FinanceMonthVo"
        },
        "msg": {
          "type": "string",
          "description": "消息"
        }
      },
      "title": "Result«FinanceMonthVo»"
    },
    "Result«MonthVo»": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "处理状态：0: 成功, 1: 失败"
        },
        "data": {
          "description": "返回数据",
          "originalRef": "MonthVo",
          "$ref": "#/definitions/MonthVo"
        },
        "msg": {
          "type": "string",
          "description": "消息"
        }
      },
      "title": "Result«MonthVo»"
    }
  }
}