access-control-monitor/docs/swagger.json

{
    "swagger": "2.0",
    "info": {
        "description": "This is a gateway server. On the page, you can go to do testing for every API.",
        "title": "Project access-control-monitor's APIs",
        "contact": {},
        "license": {},
        "version": "1.1"
    },
    "paths": {
        "/api/v1/attendance": {
            "put": {
                "description": "上传考勤数据",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "user"
                ],
                "summary": "上传考勤数据",
                "parameters": [
                    {
                        "description": "上传考勤数据",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/v1.AttendanceRequest"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "$ref": "#/definitions/v1.AttendanceResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/base.HTTPError"
                        }
                    }
                }
            }
        },
        "/api/v1/auth": {
            "put": {
                "description": "授权获取key",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "user"
                ],
                "summary": "授权获取key",
                "parameters": [
                    {
                        "description": "授权信息",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/v1.LoginBody"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "$ref": "#/definitions/v1.LoginResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/base.HTTPError"
                        }
                    }
                }
            }
        },
        "/api/v1/delete": {
            "put": {
                "description": "删除员工信息",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "user"
                ],
                "summary": "删除员工信息",
                "parameters": [
                    {
                        "description": "删除人员",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/v1.StaffDeleteBody"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "$ref": "#/definitions/v1.StaffDeleteResp"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/base.HTTPError"
                        }
                    }
                }
            }
        },
        "/api/v1/register": {
            "post": {
                "description": "上传员工信息",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "user"
                ],
                "summary": "上传员工信息",
                "parameters": [
                    {
                        "description": "上传员工信息",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/v1.RegisterRequest"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "$ref": "#/definitions/v1.RegisterResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/base.HTTPError"
                        }
                    }
                }
            }
        },
        "/ping": {
            "put": {
                "description": "心跳",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "heatbeat"
                ],
                "summary": "心跳",
                "parameters": [
                    {
                        "description": "sn",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/v1.PingBody"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "schema": {
                            "$ref": "#/definitions/v1.PingResponse"
                        }
                    },
                    "500": {
                        "description": "Internal Server Error",
                        "schema": {
                            "$ref": "#/definitions/base.HTTPError"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "base.HTTPError": {
            "type": "object",
            "properties": {
                "code": {
                    "type": "integer",
                    "format": "int",
                    "example": 500
                },
                "message": {
                    "type": "string",
                    "example": "status bad request"
                }
            }
        },
        "v1.AttendanceContent": {
            "type": "object",
            "required": [
                "is_in",
                "recog_time",
                "work_no"
            ],
            "properties": {
                "is_in": {
                    "type": "integer"
                },
                "recog_time": {
                    "type": "string"
                },
                "work_no": {
                    "type": "string"
                }
            }
        },
        "v1.AttendanceRequest": {
            "type": "object",
            "required": [
                "content",
                "sn"
            ],
            "properties": {
                "content": {
                    "description": "json 数组 Content 里面的内容用 des 加密 deskey: 对接的时候提供,\n加密前格式：\n{\n\"count\": 2,\n\"logs\":[\n{\"sn\": \"XXXX\",\"user_id\": \"XXXXX\",\"recog_time\":\n\"yyyy-Mm-dd HH:mm:SS\"},\n{\"sn\": \"XXXX\",\"user_id\": \"XXXXX\",\"recog_time\": \"yyyy-M\nm-dd HH:mm:SS\"}\n] }\nAppKey  string              `form:\"app_key\" json:\"app_key\" binding:\"required\"`",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/v1.AttendanceContent"
                    }
                },
                "sn": {
                    "type": "string"
                }
            }
        },
        "v1.AttendanceResponse": {
            "type": "object",
            "properties": {
                "code": {
                    "description": "返回码",
                    "type": "integer",
                    "format": "int",
                    "default": 0
                },
                "message": {
                    "description": "消息",
                    "type": "string",
                    "default": "success"
                }
            }
        },
        "v1.LoginBody": {
            "type": "object",
            "required": [
                "sn"
            ],
            "properties": {
                "sn": {
                    "type": "string"
                }
            }
        },
        "v1.LoginResp": {
            "type": "object",
            "properties": {
                "key": {
                    "type": "string"
                }
            }
        },
        "v1.LoginResponse": {
            "type": "object",
            "properties": {
                "code": {
                    "description": "返回码",
                    "type": "integer",
                    "format": "int",
                    "default": 0
                },
                "data": {
                    "type": "object",
                    "$ref": "#/definitions/v1.LoginResp"
                },
                "message": {
                    "description": "消息",
                    "type": "string",
                    "default": "success"
                }
            }
        },
        "v1.PingBody": {
            "type": "object",
            "required": [
                "sn"
            ],
            "properties": {
                "sn": {
                    "type": "string"
                }
            }
        },
        "v1.PingResponse": {
            "type": "object",
            "properties": {
                "code": {
                    "description": "返回码",
                    "type": "integer",
                    "format": "int",
                    "default": 0
                },
                "message": {
                    "description": "消息",
                    "type": "string",
                    "default": "success"
                }
            }
        },
        "v1.RegisterRequest": {
            "type": "object",
            "required": [
                "address",
                "birthday",
                "gender",
                "group",
                "id_cert",
                "id_issue",
                "id_period",
                "id_photo",
                "inf_photo",
                "labor_company",
                "name",
                "phone",
                "photo",
                "sn",
                "staff_type",
                "work_no",
                "work_type"
            ],
            "properties": {
                "address": {
                    "type": "string"
                },
                "birthday": {
                    "type": "string"
                },
                "gender": {
                    "type": "integer"
                },
                "group": {
                    "type": "string"
                },
                "id_cert": {
                    "type": "string"
                },
                "id_issue": {
                    "type": "string"
                },
                "id_period": {
                    "type": "string"
                },
                "id_photo": {
                    "type": "string"
                },
                "inf_photo": {
                    "type": "string"
                },
                "labor_company": {
                    "type": "string"
                },
                "name": {
                    "type": "string"
                },
                "phone": {
                    "type": "string"
                },
                "photo": {
                    "type": "string"
                },
                "sn": {
                    "type": "string"
                },
                "staff_type": {
                    "type": "integer"
                },
                "work_no": {
                    "description": "AppKey       string `form:\"app_key\" json:\"app_key\" binding:\"required\"`",
                    "type": "string"
                },
                "work_type": {
                    "type": "integer"
                }
            }
        },
        "v1.RegisterResponse": {
            "type": "object",
            "properties": {
                "code": {
                    "description": "返回码",
                    "type": "integer",
                    "format": "int",
                    "default": 0
                },
                "message": {
                    "description": "消息",
                    "type": "string",
                    "default": "success"
                }
            }
        },
        "v1.StaffDeleteBody": {
            "type": "object",
            "required": [
                "sn",
                "work_nos"
            ],
            "properties": {
                "sn": {
                    "type": "string"
                },
                "work_nos": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            }
        },
        "v1.StaffDeleteResp": {
            "type": "object",
            "properties": {
                "work_nos": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            }
        }
    }
}