lzyd-user-api/docs/swagger.yaml

basePath: /
definitions:
  models.GetBlackListReq:
    properties:
      type:
        description: 类型
        type: integer
      user_id:
        description: 用户ID
        type: string
    type: object
  models.QuickLoginReq:
    properties:
      mobile_phone:
        type: string
      valid_code:
        type: string
    type: object
  models.SendSmsReq:
    properties:
      content:
        type: string
      mobile:
        type: string
    type: object
  models.UpdateProfileReq:
    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
    type: object
  models.UploadBaseReq:
    properties:
      base64:
        description: base64字符串
        type: string
      map_base:
        description: mapBase64
        type: string
      task_id:
        description: 任务id
        type: string
      user_id:
        description: 用户id
        type: string
    type: object
info:
  contact: {}
  description: This is a gin blog example
  title: gin-blog API
  version: 0.0.1
paths:
  /area/getArea:
    get:
      description: 获取省市区
      parameters:
      - description: 地区code
        in: query
        name: p_code
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200,"message":"success","data":{"token":"","customer":{"id":"","code":"","name":""}}}'
          schema:
            type: string
      summary: 获取省市区
      tags:
      - area
  /cert/list:
    get:
      description: 获取证书列表
      parameters:
      - description: 类型:传1
        in: query
        name: type
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200,"message":"success","data":{"token":"","customer":{"id":"","code":"","name":""}}}'
          schema:
            type: string
      summary: 获取证书列表
      tags:
      - cert
  /cert/userList:
    get:
      description: 获取用户获得证书列表
      parameters:
      - description: 用户id
        in: query
        name: userId
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200,"message":"success","data":{"token":"","customer":{"id":"","code":"","name":""}}}'
          schema:
            type: string
      summary: 获取用户获得证书列表
      tags:
      - cert
  /customer/getBlacklist:
    post:
      description: 获取用户黑白名单列表
      parameters:
      - description: 获取黑白名单列表
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/models.GetBlackListReq'
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200,"message":"success","data":{"token":"","customer":{"user_id":"","username":"","user_avatar":"https://"}}}'
          schema:
            type: string
      summary: 获取用户黑白名单列表
      tags:
      - Customer
  /customer/getInfo:
    get:
      description: 获取用户详细信息
      parameters:
      - description: 用户ID
        in: query
        name: user_id
        required: true
        type: string
      - description: 另一个用户id
        in: query
        name: other_id
        type: string
      produces:
      - application/json
      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
      summary: 获取用户详细信息
      tags:
      - Customer
  /customer/order:
    get:
      description: 获取赛事订单
      parameters:
      - description: 用户ID
        in: query
        name: user_id
        required: true
        type: string
      produces:
      - application/json
      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
      summary: 获取赛事订单
      tags:
      - Customer
  /customer/qualifying:
    get:
      description: 获取排位赛列表
      parameters:
      - description: 用户ID
        in: query
        name: user_id
        required: true
        type: string
      produces:
      - application/json
      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
      summary: 获取排位赛列表
      tags:
      - Customer
  /customer/updateProfile:
    post:
      description: 修改用户资料
      parameters:
      - description: 修改用户资料请求内容
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/models.UpdateProfileReq'
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200,"message":"success","data":{}}'
          schema:
            type: string
      summary: 修改用户资料
      tags:
      - Customer
  /customer/uploadBase64:
    post:
      description: 上传base64图片
      parameters:
      - description: 修改用户资料请求内容
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/models.UploadBaseReq'
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200,"message":"success","data":{}}'
          schema:
            type: string
      summary: 上传base64图片
      tags:
      - Customer
  /medal/list:
    get:
      description: 获取勋章列表
      parameters:
      - description: 类型:传1
        in: query
        name: type
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200,"message":"success","data":{"token":"","customer":{"id":"","code":"","name":""}}}'
          schema:
            type: string
      summary: 获取勋章列表
      tags:
      - medal
  /medal/userList:
    get:
      description: 获取用户获得勋章列表
      parameters:
      - description: 用户id
        in: query
        name: userId
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200,"message":"success","data":{"token":"","customer":{"id":"","code":"","name":""}}}'
          schema:
            type: string
      summary: 获取用户获得勋章列表
      tags:
      - medal
  /passport/quickLogin:
    post:
      consumes:
      - application/json
      description: 登录注册
      parameters:
      - description: 快捷登录请求内容
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/models.QuickLoginReq'
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200,"message":"success","data":{"token":"","user":{}}}'
          schema:
            type: string
      security:
      - ApiKeyAuth: []
      summary: 登录注册
      tags:
      - Passport
  /sms/get:
    get:
      description: 获取短信验证码
      parameters:
      - description: 手机号码
        in: query
        name: mobile
        required: true
        type: string
      - default: 1
        description: 短信验证码类型(1=注册登录)
        enum:
        - 1
        - 2
        - 3
        - 4
        in: query
        name: type
        required: true
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200, "message":"success"}'
          schema:
            type: string
      security:
      - ApiKeyAuth: []
      summary: 获取短信验证码
      tags:
      - Sms
  /sms/remind:
    post:
      consumes:
      - application/json
      description: 发送提醒短信
      parameters:
      - description: 短信请求内容
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/models.SendSmsReq'
      produces:
      - application/json
      responses:
        "200":
          description: '{"code":200, "message":"success"}'
          schema:
            type: string
      security:
      - ApiKeyAuth: []
      summary: 发送提醒短信
      tags:
      - Sms
securityDefinitions:
  ApiKeyAuth:
    in: header
    name: x-app-id
    type: apiKey
swagger: "2.0"