go-gin-api/docs/swagger.json

{
    "swagger": "2.0",
    "info": {
        "title": "swagger 接口文档",
        "contact": {},
        "license": {
            "name": "MIT",
            "url": "https://github.com/xinliangnote/go-gin-api/blob/master/LICENSE"
        },
        "version": "2.0"
    },
    "host": "127.0.0.1:9999",
    "paths": {
        "/auth/get": {
            "post": {
                "description": "获取授权信息",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Demo"
                ],
                "summary": "获取授权信息",
                "responses": {
                    "200": {
                        "description": "返回信息",
                        "schema": {
                            "$ref": "#/definitions/demo.authResponse"
                        }
                    }
                }
            }
        },
        "/demo/trace": {
            "get": {
                "description": "Trace 示例",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Demo"
                ],
                "summary": "Trace 示例",
                "parameters": [
                    {
                        "type": "string",
                        "description": "签名",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "用户信息",
                        "schema": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "job": {
                                        "description": "工作",
                                        "type": "string"
                                    },
                                    "name": {
                                        "description": "用户名",
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/user/create": {
            "post": {
                "description": "创建用户",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "User"
                ],
                "summary": "创建用户",
                "parameters": [
                    {
                        "description": "请求信息",
                        "name": "RequestInfo",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/user_model.CreateRequest"
                        }
                    },
                    {
                        "type": "string",
                        "description": "签名",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "返回信息",
                        "schema": {
                            "$ref": "#/definitions/user_model.CreateResponse"
                        }
                    }
                }
            }
        },
        "/user/delete/{id}": {
            "patch": {
                "description": "删除用户 - 更新 is_deleted = 1",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "User"
                ],
                "summary": "删除用户 - 更新 is_deleted = 1",
                "parameters": [
                    {
                        "type": "integer",
                        "description": "用户ID",
                        "name": "id",
                        "in": "path",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "签名",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "返回信息"
                    }
                }
            }
        },
        "/user/info/{username}": {
            "get": {
                "description": "用户详情",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "User"
                ],
                "summary": "用户详情",
                "parameters": [
                    {
                        "type": "string",
                        "description": "用户名",
                        "name": "username",
                        "in": "path",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "签名",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "返回信息",
                        "schema": {
                            "$ref": "#/definitions/user_model.DetailResponse"
                        }
                    }
                }
            }
        },
        "/user/update": {
            "put": {
                "description": "编辑用户 - 通过用户主键ID更新用户昵称",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "User"
                ],
                "summary": "编辑用户 - 通过用户主键ID更新用户昵称",
                "parameters": [
                    {
                        "description": "请求信息",
                        "name": "RequestInfo",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/user_model.UpdateNickNameByIDRequest"
                        }
                    },
                    {
                        "type": "string",
                        "description": "签名",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "返回信息",
                        "schema": {
                            "$ref": "#/definitions/user_model.UpdateNickNameByIDResponse"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "demo.authResponse": {
            "type": "object",
            "properties": {
                "authorization": {
                    "description": "签名",
                    "type": "string"
                },
                "expire_time": {
                    "description": "过期时间",
                    "type": "integer"
                }
            }
        },
        "user_model.CreateRequest": {
            "type": "object",
            "properties": {
                "mobile": {
                    "description": "手机号",
                    "type": "string"
                },
                "nick_name": {
                    "description": "昵称",
                    "type": "string"
                },
                "user_name": {
                    "description": "用户名",
                    "type": "string"
                }
            }
        },
        "user_model.CreateResponse": {
            "type": "object",
            "properties": {
                "id": {
                    "description": "主键ID",
                    "type": "integer"
                }
            }
        },
        "user_model.DetailResponse": {
            "type": "object",
            "properties": {
                "id": {
                    "description": "用户主键ID",
                    "type": "integer"
                },
                "mobile": {
                    "description": "手机号",
                    "type": "string"
                },
                "nick_name": {
                    "description": "昵称",
                    "type": "string"
                },
                "user_name": {
                    "description": "用户名",
                    "type": "string"
                }
            }
        },
        "user_model.UpdateNickNameByIDRequest": {
            "type": "object",
            "properties": {
                "id": {
                    "description": "用户主键ID",
                    "type": "integer"
                },
                "nick_name": {
                    "description": "昵称",
                    "type": "string"
                }
            }
        },
        "user_model.UpdateNickNameByIDResponse": {
            "type": "object",
            "properties": {
                "id": {
                    "description": "用户主键ID",
                    "type": "integer"
                }
            }
        }
    }
}