lzyd-user-api/docs/docs.go

// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag

package docs

import (
	"bytes"
	"encoding/json"
	"strings"

	"github.com/alecthomas/template"
	"github.com/swaggo/swag"
)

var doc = `{
    "schemes": {{ marshal .Schemes }},
    "swagger": "2.0",
    "info": {
        "description": "{{.Description}}",
        "title": "{{.Title}}",
        "contact": {},
        "version": "{{.Version}}"
    },
    "host": "{{.Host}}",
    "basePath": "{{.BasePath}}",
    "paths": {
        "/area/getArea": {
            "get": {
                "description": "获取省市区",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "area"
                ],
                "summary": "获取省市区",
                "parameters": [
                    {
                        "type": "string",
                        "description": "地区code",
                        "name": "p_code",
                        "in": "query"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"customer\":{\"id\":\"\",\"code\":\"\",\"name\":\"\"}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/cert/list": {
            "get": {
                "description": "获取证书列表",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "cert"
                ],
                "summary": "获取证书列表",
                "parameters": [
                    {
                        "type": "string",
                        "description": "类型:传1",
                        "name": "type",
                        "in": "query"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"customer\":{\"id\":\"\",\"code\":\"\",\"name\":\"\"}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/cert/userList": {
            "get": {
                "description": "获取用户获得证书列表",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "cert"
                ],
                "summary": "获取用户获得证书列表",
                "parameters": [
                    {
                        "type": "string",
                        "description": "用户id",
                        "name": "userId",
                        "in": "query"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"customer\":{\"id\":\"\",\"code\":\"\",\"name\":\"\"}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/customer/getBlacklist": {
            "post": {
                "description": "获取用户黑白名单列表",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Customer"
                ],
                "summary": "获取用户黑白名单列表",
                "parameters": [
                    {
                        "description": "获取黑白名单列表",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/models.GetBlackListReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"customer\":{\"user_id\":\"\",\"username\":\"\",\"user_avatar\":\"https://\"}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/customer/getInfo": {
            "get": {
                "description": "获取用户详细信息",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Customer"
                ],
                "summary": "获取用户详细信息",
                "parameters": [
                    {
                        "type": "string",
                        "description": "用户ID",
                        "name": "user_id",
                        "in": "query",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "另一个用户id",
                        "name": "other_id",
                        "in": "query"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"customer\":{\"user_id\":\"\",\"mobile_phone\":\"\",\"user_name\":\"\",\"avatar\":\"https://\",\"gender\":2,\"birthday\":\"\",\"area\":\"江苏省-南京市-鼓楼区\",\"email\":\"\",\"customer_level\":0,\"user_point\":0,\"user_money\":0.00,\"register_time\":\"\"}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/customer/order": {
            "get": {
                "description": "获取赛事订单",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Customer"
                ],
                "summary": "获取赛事订单",
                "parameters": [
                    {
                        "type": "string",
                        "description": "用户ID",
                        "name": "user_id",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"customer\":{\"user_id\":\"\",\"mobile_phone\":\"\",\"user_name\":\"\",\"avatar\":\"https://\",\"gender\":2,\"birthday\":\"\",\"area\":\"江苏省-南京市-鼓楼区\",\"email\":\"\",\"customer_level\":0,\"user_point\":0,\"user_money\":0.00,\"register_time\":\"\"}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/customer/qualifying": {
            "get": {
                "description": "获取排位赛列表",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Customer"
                ],
                "summary": "获取排位赛列表",
                "parameters": [
                    {
                        "type": "string",
                        "description": "用户ID",
                        "name": "user_id",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"customer\":{\"user_id\":\"\",\"mobile_phone\":\"\",\"user_name\":\"\",\"avatar\":\"https://\",\"gender\":2,\"birthday\":\"\",\"area\":\"江苏省-南京市-鼓楼区\",\"email\":\"\",\"customer_level\":0,\"user_point\":0,\"user_money\":0.00,\"register_time\":\"\"}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/customer/updateProfile": {
            "post": {
                "description": "修改用户资料",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Customer"
                ],
                "summary": "修改用户资料",
                "parameters": [
                    {
                        "description": "修改用户资料请求内容",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/models.UpdateProfileReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/customer/uploadBase64": {
            "post": {
                "description": "上传base64图片",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Customer"
                ],
                "summary": "上传base64图片",
                "parameters": [
                    {
                        "description": "修改用户资料请求内容",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/models.UploadBaseReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/medal/list": {
            "get": {
                "description": "获取勋章列表",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "medal"
                ],
                "summary": "获取勋章列表",
                "parameters": [
                    {
                        "type": "string",
                        "description": "类型:传1",
                        "name": "type",
                        "in": "query"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"customer\":{\"id\":\"\",\"code\":\"\",\"name\":\"\"}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/medal/userList": {
            "get": {
                "description": "获取用户获得勋章列表",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "medal"
                ],
                "summary": "获取用户获得勋章列表",
                "parameters": [
                    {
                        "type": "string",
                        "description": "用户id",
                        "name": "userId",
                        "in": "query"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"customer\":{\"id\":\"\",\"code\":\"\",\"name\":\"\"}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/passport/quickLogin": {
            "post": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "description": "登录注册",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Passport"
                ],
                "summary": "登录注册",
                "parameters": [
                    {
                        "description": "快捷登录请求内容",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/models.QuickLoginReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200,\"message\":\"success\",\"data\":{\"token\":\"\",\"user\":{}}}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/sms/get": {
            "get": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "description": "获取短信验证码",
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Sms"
                ],
                "summary": "获取短信验证码",
                "parameters": [
                    {
                        "type": "string",
                        "description": "手机号码",
                        "name": "mobile",
                        "in": "query",
                        "required": true
                    },
                    {
                        "enum": [
                            1,
                            2,
                            3,
                            4
                        ],
                        "type": "integer",
                        "default": 1,
                        "description": "短信验证码类型(1=注册登录)",
                        "name": "type",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/sms/remind": {
            "post": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "description": "发送提醒短信",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Sms"
                ],
                "summary": "发送提醒短信",
                "parameters": [
                    {
                        "description": "短信请求内容",
                        "name": "body",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/models.SendSmsReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\":200, \"message\":\"success\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "models.GetBlackListReq": {
            "type": "object",
            "properties": {
                "type": {
                    "description": "类型",
                    "type": "integer"
                },
                "user_id": {
                    "description": "用户ID",
                    "type": "string"
                }
            }
        },
        "models.QuickLoginReq": {
            "type": "object",
            "properties": {
                "mobile_phone": {
                    "type": "string"
                },
                "valid_code": {
                    "type": "string"
                }
            }
        },
        "models.SendSmsReq": {
            "type": "object",
            "properties": {
                "content": {
                    "type": "string"
                },
                "mobile": {
                    "type": "string"
                }
            }
        },
        "models.UpdateProfileReq": {
            "type": "object",
            "properties": {
                "area": {
                    "description": "地区",
                    "type": "string"
                },
                "birthday": {
                    "description": "生日",
                    "type": "string"
                },
                "gender": {
                    "description": "性别",
                    "type": "integer"
                },
                "height": {
                    "description": "用户身高",
                    "type": "integer"
                },
                "user_avatar": {
                    "description": "地区",
                    "type": "string"
                },
                "user_id": {
                    "description": "用户代码",
                    "type": "string"
                },
                "username": {
                    "description": "会员昵称",
                    "type": "string"
                },
                "weight": {
                    "description": "用户体重",
                    "type": "integer"
                }
            }
        },
        "models.UploadBaseReq": {
            "type": "object",
            "properties": {
                "base64": {
                    "description": "base64字符串",
                    "type": "string"
                },
                "map_base": {
                    "description": "mapBase64",
                    "type": "string"
                },
                "task_id": {
                    "description": "任务id",
                    "type": "string"
                },
                "user_id": {
                    "description": "用户id",
                    "type": "string"
                }
            }
        }
    },
    "securityDefinitions": {
        "ApiKeyAuth": {
            "type": "apiKey",
            "name": "x-app-id",
            "in": "header"
        }
    }
}`

type swaggerInfo struct {
	Version     string
	Host        string
	BasePath    string
	Schemes     []string
	Title       string
	Description string
}

// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = swaggerInfo{
	Version:     "0.0.1",
	Host:        "",
	BasePath:    "/",
	Schemes:     []string{},
	Title:       "gin-blog API",
	Description: "This is a gin blog example",
}

type s struct{}

func (s *s) ReadDoc() string {
	sInfo := SwaggerInfo
	sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1)

	t, err := template.New("swagger_info").Funcs(template.FuncMap{
		"marshal": func(v interface{}) string {
			a, _ := json.Marshal(v)
			return string(a)
		},
	}).Parse(doc)
	if err != nil {
		return doc
	}

	var tpl bytes.Buffer
	if err := t.Execute(&tpl, sInfo); err != nil {
		return doc
	}

	return tpl.String()
}

func init() {
	swag.Register(swag.Name, &s{})
}