90fad6bc创建于 2024年12月25日历史提交
{
  "swagger": "2.0",
  "info": {
    "title": "user-api",
    "description": "user api",
    "version": "v1"
  },
  "schemes": [
    "http",
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/v1/user/delete": {
      "delete": {
        "summary": "删除用户信息",
        "operationId": "del",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/DeleteUserResp"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/DeleteUserReq"
            }
          }
        ],
        "tags": [
          "user"
        ],
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/v1/user/health": {
      "get": {
        "summary": "健康检查",
        "operationId": "health",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/HealthResp"
            }
          }
        },
        "parameters": [
          {
            "name": "ping",
            "in": "query",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "user"
        ]
      }
    },
    "/v1/user/info": {
      "get": {
        "summary": "获取用户信息",
        "operationId": "detail",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/UserInfoResp"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": true,
            "type": "integer",
            "format": "int64"
          }
        ],
        "tags": [
          "user"
        ],
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/v1/user/login": {
      "post": {
        "summary": "用户登入",
        "operationId": "login",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/LoginResp"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/LoginReq"
            }
          }
        ],
        "tags": [
          "user"
        ]
      }
    },
    "/v1/user/register": {
      "post": {
        "summary": "用户注册",
        "operationId": "register",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/RegisterResp"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/RegisterReq"
            }
          }
        ],
        "tags": [
          "user"
        ]
      }
    },
    "/v1/user/update": {
      "put": {
        "summary": "修改用户信息",
        "operationId": "update",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/UpdateUserResp"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UpdateUserReq"
            }
          }
        ],
        "tags": [
          "user"
        ],
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    }
  },
  "definitions": {
    "DeleteUserReq": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        }
      },
      "title": "DeleteUserReq",
      "required": [
        "id"
      ]
    },
    "DeleteUserResp": {
      "type": "object",
      "properties": {
        "status": {
          "type": "boolean",
          "format": "boolean"
        }
      },
      "title": "DeleteUserResp",
      "required": [
        "status"
      ]
    },
    "HealthReq": {
      "type": "object",
      "properties": {
        "ping": {
          "type": "string"
        }
      },
      "title": "HealthReq",
      "required": [
        "ping"
      ]
    },
    "HealthResp": {
      "type": "object",
      "properties": {
        "pong": {
          "type": "string"
        }
      },
      "title": "HealthResp",
      "required": [
        "pong"
      ]
    },
    "LoginReq": {
      "type": "object",
      "properties": {
        "mobile": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      },
      "title": "LoginReq",
      "required": [
        "mobile",
        "password"
      ]
    },
    "LoginResp": {
      "type": "object",
      "properties": {
        "token": {
          "type": "string"
        },
        "expire": {
          "type": "integer",
          "format": "int64"
        }
      },
      "title": "LoginResp",
      "required": [
        "token",
        "expire"
      ]
    },
    "RegisterReq": {
      "type": "object",
      "properties": {
        "mobile": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        }
      },
      "title": "RegisterReq",
      "required": [
        "mobile",
        "password",
        "name"
      ]
    },
    "RegisterResp": {
      "type": "object",
      "properties": {
        "token": {
          "type": "string"
        },
        "expire": {
          "type": "integer",
          "format": "int64"
        }
      },
      "title": "RegisterResp",
      "required": [
        "token",
        "expire"
      ]
    },
    "UpdateUserReq": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "mobile": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        }
      },
      "title": "UpdateUserReq",
      "required": [
        "id"
      ]
    },
    "UpdateUserResp": {
      "type": "object",
      "properties": {
        "status": {
          "type": "boolean",
          "format": "boolean"
        }
      },
      "title": "UpdateUserResp",
      "required": [
        "status"
      ]
    },
    "User": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "mobile": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        }
      },
      "title": "User",
      "required": [
        "id",
        "mobile",
        "name",
        "gender"
      ]
    },
    "UserInfoReq": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        }
      },
      "title": "UserInfoReq",
      "required": [
        "id"
      ]
    },
    "UserInfoResp": {
      "type": "object",
      "properties": {
        "userInfo": {
          "$ref": "#/definitions/User"
        }
      },
      "title": "UserInfoResp",
      "required": [
        "userInfo"
      ]
    }
  },
  "securityDefinitions": {
    "apiKey": {
      "type": "apiKey",
      "description": "Enter JWT Bearer token **_only_**",
      "name": "Authorization",
      "in": "header"
    }
  }
}