community_team/docs/swagger.yaml

basePath: /
definitions:
  hdl.PrivilegeOpenCardOrdQueryPageResp:
    properties:
      btn_bg_color_1:
        type: string
      btn_bg_color_2:
        type: string
      btn_text:
        type: string
      btn_text_color:
        type: string
      header_img:
        type: string
      logistic_company:
        items:
          $ref: '#/definitions/model.LogisticCompany'
        type: array
    type: object
  hdl.PrivilegeOpenCardOrdQueryReq:
    properties:
      com:
        description: 快递公司名称
        type: string
      num:
        description: 快递单号
        type: string
    required:
    - com
    - num
    type: object
  hdl.logisticQueryReq:
    properties:
      com:
        description: 快递公司名称
        type: string
      num:
        description: 快递单号
        type: string
    required:
    - com
    - num
    type: object
  hdl.privilegeOpenCardCheckReq:
    properties:
      key:
        description: 卡密
        type: string
      num:
        description: 卡号
        type: string
    required:
    - key
    - num
    type: object
  hdl.privilegeOpenCardPayPageResp:
    properties:
      amount:
        description: 付费金额
        type: string
      card_type:
        description: 卡的类型："1"实体卡   "2"虚拟卡
        type: string
      date_type:
        description: 日期类型：month:月 season：季 year：年 forever：永久
        type: string
      page_style:
        $ref: '#/definitions/hdl.privilegeOpenCardPayStyle'
        description: 页面样式
    type: object
  hdl.privilegeOpenCardPayStyle:
    properties:
      exclusive_privilege:
        description: 专属特权
        items:
          properties:
            brand_id:
              type: string
            brand_img:
              type: string
            brand_img_url:
              type: string
            brand_name:
              type: string
            is_show:
              type: string
            sub_title:
              type: string
          type: object
        type: array
      payment_btn:
        description: 底部支付按钮
        items:
          properties:
            bg_img:
              type: string
            bg_img_url:
              type: string
            func:
              type: string
            name:
              type: string
            text:
              type: string
            text_color:
              type: string
            type:
              type: string
          type: object
        type: array
      payment_choose_icon:
        description: 支付方式选中、未选中图标
        items:
          properties:
            icon:
              type: string
            icon_url:
              type: string
            type:
              type: string
          type: object
        type: array
      payment_style:
        description: 支付方式
        items:
          properties:
            icon:
              type: string
            icon_url:
              type: string
            type:
              type: string
          type: object
        type: array
      style:
        description: 头部样式
        properties:
          header_bg_img:
            type: string
          header_bg_img_url:
            type: string
          special_deals_img:
            type: string
          special_deals_img_url:
            type: string
          special_deals_text:
            type: string
        type: object
    type: object
  hdl.resultItem:
    properties:
      id:
        example: "440100000000"
        type: string
      name:
        example: city
        type: string
    type: object
  hdl.updateAddressReq:
    properties:
      city_id:
        type: string
      county_id:
        type: string
      detail:
        type: string
      id:
        type: integer
      phone:
        type: string
      post_code:
        type: string
      province_id:
        type: string
      receiver:
        type: string
      tag:
        type: string
    required:
    - city_id
    - county_id
    - detail
    - phone
    - province_id
    - receiver
    type: object
  md.Apple:
    properties:
      token:
        type: string
    type: object
  md.FastLoginRequestBody:
    properties:
      apple:
        $ref: '#/definitions/md.Apple'
      captcha:
        type: string
      is_not_create:
        type: string
      mobile:
        type: string
      parent_uid:
        type: string
      qq:
        $ref: '#/definitions/md.QQLogin'
      return_user_msg:
        type: string
      taobao:
        $ref: '#/definitions/md.TaobaoLogin'
      wechat:
        $ref: '#/definitions/md.WeChat'
      wechat_mini:
        $ref: '#/definitions/md.WeChatMiniApp'
      zone:
        type: string
    type: object
  md.IndexRecommendList:
    properties:
      good:
        items:
          $ref: '#/definitions/md.RecommendGood'
        type: array
      provider:
        description: BarTitleList                []BarTitle      `json:"bar_title_list"`
        type: string
    type: object
  md.LoginResponse:
    properties:
      bind_phone_enable:
        type: string
      is_pid:
        type: string
      perms:
        items:
          type: string
        type: array
      phone:
        type: string
      register_invite_code_enable:
        type: string
      register_popup_condition:
        $ref: '#/definitions/md.RegisterPopupCondition'
        description: 弹出类型设置
      token:
        type: string
      user_id:
        type: string
      username:
        type: string
      wechat_applet_open_id:
        type: string
      wechat_union_id:
        type: string
    type: object
  md.Marquee:
    properties:
      avatar_url:
        type: string
      content:
        type: string
      name:
        type: string
    type: object
  md.ProductDetailResponse:
    properties:
      commission:
        type: string
      coupon_price:
        type: string
      good_id:
        type: string
      mod_list:
        items:
          additionalProperties: true
          type: object
        type: array
      provider:
        type: string
      provider_name:
        type: string
      shop_avatar:
        type: string
    type: object
  md.QQLogin:
    properties:
      access_token:
        type: string
      avatar_url:
        type: string
      city:
        type: string
      expires_in:
        type: string
      gender:
        type: string
      nickname:
        type: string
      open_id:
        type: string
      pay_token:
        type: string
      pf:
        type: string
      pf_key:
        type: string
      province:
        type: string
      ret:
        type: string
      unionid:
        type: string
    type: object
  md.RecommendGood:
    properties:
      commission:
        type: string
      coupon:
        type: string
      current_price:
        type: string
      detail_data:
        $ref: '#/definitions/md.ProductDetailResponse'
      good_id:
        type: string
      good_image:
        type: string
      good_title:
        type: string
      inorder_count:
        type: string
      is_collect:
        type: integer
      is_coupons:
        type: integer
      is_share:
        type: integer
      market_price:
        type: string
      marquee_list:
        items:
          $ref: '#/definitions/md.Marquee'
        type: array
      provider:
        type: string
      provider_name:
        type: string
      pvd:
        type: string
      shop_avatar:
        type: string
      shop_name:
        type: string
      video:
        type: string
    type: object
  md.RegisterPopupCondition:
    properties:
      invite_code:
        description: 邀请码设置：弹出类型是激活码的时候起作用
        properties:
          popup:
            description: 是否弹出 “0”否 “1”是
            type: string
          should_input:
            description: 是否必填 “0”否 “1”是
            type: string
        type: object
      popup_type:
        description: 弹出类型：“0”关闭 ”1”激活码 “2”邀请码
        type: string
      should_input:
        description: 是否必填 “0”否 “1”是
        type: string
    type: object
  md.TaobaoLogin:
    properties:
      access_token:
        type: string
      auth_code:
        type: string
      avatar_url:
        type: string
      nick_name:
        type: string
      open_id:
        type: string
      sid:
        type: string
    type: object
  md.WeChat:
    properties:
      access_token:
        type: string
      avatar_url:
        type: string
      city:
        type: string
      expires_in:
        type: string
      gender:
        type: string
      nickname:
        type: string
      open_id:
        type: string
      pay_token:
        type: string
      pf:
        type: string
      pf_key:
        type: string
      province:
        type: string
      ret:
        type: string
      unionid:
        type: string
    type: object
  md.WeChatMiniApp:
    properties:
      avatar:
        type: string
      code:
        type: string
      nickname:
        type: string
      open_id:
        type: string
      unionid:
        type: string
    type: object
  model.LogisticCompany:
    properties:
      code:
        type: string
      name:
        type: string
    type: object
  model.PrivilegeOpenCardOrd:
    properties:
      address:
        type: string
      after_sale_id:
        type: integer
      card_key:
        type: string
      card_num:
        type: string
      card_type:
        type: integer
      cost_price:
        type: string
      create_time:
        type: string
      date_type:
        type: integer
      given_data:
        type: string
      logistic_company:
        type: string
      logistic_num:
        type: string
      ord_id:
        type: integer
      pay_channel:
        type: integer
      pay_time:
        type: string
      phone:
        type: string
      receiver:
        type: string
      settle_at:
        type: integer
      state:
        type: integer
      uid:
        type: integer
      update_time:
        type: string
    type: object
  model.UserAddress:
    properties:
      city_id:
        type: string
      city_name:
        type: string
      county_id:
        type: string
      county_name:
        type: string
      detail:
        type: string
      id:
        type: integer
      phone:
        type: string
      post_code:
        type: string
      province_id:
        type: string
      province_name:
        type: string
      receiver:
        type: string
      tag:
        type: string
      uid:
        type: integer
    type: object
host: localhost:5000
info:
  contact:
    name: sherlockwhite
  description: 移动端接口
  termsOfService: 智莺生活后端组
  title: 智莺生活移动端接口
  version: "1.0"
paths:
  /api/v1/acq/fix:
    get:
      consumes:
      - application/json
      description: 拉新活动--fix
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 拉新活动--fix
      tags:
      - 拉新活动
  /api/v1/acquisition/home:
    post:
      consumes:
      - application/json
      description: 本期榜单/上期榜单/我的邀请人数和奖励/任务列表
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 拉新--首页数据
      tags:
      - 拉新活动
  /api/v1/acquisition/qrcode:
    get:
      consumes:
      - application/json
      description: 二维码
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 拉新--邀请二维码
      tags:
      - 拉新活动
  /api/v1/acquisition/reward/detail:
    post:
      consumes:
      - application/json
      description: 拉新活动--我的奖励明细
      parameters:
      - description: 1为以发放，2为待发放，3为失效
        in: body
        name: state
        required: true
        schema:
          type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 拉新活动--我的奖励明细
      tags:
      - 拉新活动
  /api/v1/acquisition/reward_receive:
    post:
      consumes:
      - application/json
      description: 拉新活动--领取奖励
      parameters:
      - description: 任务ID
        in: body
        name: job_id
        required: true
        schema:
          type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 拉新活动--领取奖励
      tags:
      - 拉新活动
  /api/v1/credit/card/config:
    get:
      consumes:
      - application/json
      description: 获取信用卡配置
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 获取信用卡配置
      tags:
      - 信用卡
  /api/v1/duomai/mall/detail:
    post:
      consumes:
      - application/json
      description: 多麦商城--商城详情
      parameters:
      - description: 商城id
        in: body
        name: brand_id
        required: true
        schema:
          type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 多麦商城--商城详情
      tags:
      - 多麦商城
  /api/v1/duomai/mall/home:
    get:
      consumes:
      - application/json
      description: 多麦商城--首页数据
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 多麦商城--首页数据
      tags:
      - 多麦商城
  /api/v1/duomai/mall/search:
    post:
      consumes:
      - application/json
      description: 多麦商城--搜索
      parameters:
      - description: 搜索关键词
        in: body
        name: key
        required: true
        schema:
          type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 多麦商城--搜索
      tags:
      - 多麦商城
  /api/v1/duomai/mall/update:
    get:
      consumes:
      - application/json
      description: 多麦商城--更新数据
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 多麦商城--更新数据
      tags:
      - 多麦商城
  /api/v1/logistic/query:
    post:
      consumes:
      - application/json
      parameters:
      - description: logisticQueryReq
        in: body
        name: req
        required: true
        schema:
          $ref: '#/definitions/hdl.logisticQueryReq'
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
        "400":
          description: '{"code":400000,"data":[],"msg":"该快递公司不支持查询"}'
          schema:
            type: string
      summary: 快递100物流查询
      tags:
      - 物流
  /api/v1/mod/pub.flutter.duomai.mall.detail.page:
    get:
      consumes:
      - application/json
      description: 多麦商城详情页样式
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 多麦商城详情页样式
      tags:
      - 多麦商城
  /api/v1/mod/pub.flutter.duomai.mall.home.page:
    get:
      consumes:
      - application/json
      description: 多麦商城首页样式
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 多麦商城首页样式
      tags:
      - 多麦商城
  /api/v1/mod/pub.flutter.duomai.mall.search.page:
    get:
      consumes:
      - application/json
      description: 多麦商城搜索页样式
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 多麦商城搜索页样式
      tags:
      - 多麦商城
  /api/v1/privilege/card/activation:
    post:
      consumes:
      - application/json
      description: 权益卡激活
      parameters:
      - description: json
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/hdl.privilegeOpenCardCheckReq'
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 权益卡激活
      tags:
      - 权益卡
  /api/v1/privilege/open_card/check:
    get:
      consumes:
      - application/json
      parameters:
      - description: json
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/hdl.privilegeOpenCardCheckReq'
      produces:
      - application/json
      responses:
        "200":
          description: 0：不存在 1：已经被使用 2：可用
          schema:
            type: string
      summary: 权益卡卡号卡密检测
      tags:
      - 权益卡
  /api/v1/privilege/open_card/order_query:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/hdl.PrivilegeOpenCardOrdQueryPageResp'
        "400":
          description: '{"code":400000,"data":[],"msg":"验证码错误"}'
          schema:
            type: string
      summary: 权益卡开卡订单查询页面
      tags:
      - 权益卡
    post:
      parameters:
      - description: json
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/hdl.PrivilegeOpenCardOrdQueryReq'
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/model.PrivilegeOpenCardOrd'
        "400":
          description: '{"code":400000,"data":[],"msg":"验证码错误"}'
          schema:
            type: string
      summary: 权益卡开卡订单查询
      tags:
      - 权益卡
  /api/v1/privilege/open_card/order_suc:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/model.PrivilegeOpenCardOrd'
      summary: 订单支付成功页面
      tags:
      - 权益卡
  /api/v1/privilege/open_card/pay_page:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/hdl.privilegeOpenCardPayPageResp'
        "400":
          description: '{"code":400000,"data":[],"msg":"权益卡配置缺失"}'
          schema:
            type: string
      summary: 权益卡开卡支付页面
      tags:
      - 权益卡
  /api/v1/shake_ticket/:goods_id/:type:
    get:
      consumes:
      - application/json
      description: 收藏/领券买/分享赚
      parameters:
      - description: 商品id
        in: path
        name: goods_id
        required: true
        type: string
      - description: 类型(0取消收藏,1收藏,2点击 领券买,3点击分享赚)
        in: path
        name: type
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
      summary: 抖券商品收藏/领券买/分享赚
      tags:
      - 抖券
  /api/v1/shake_ticket_list:
    get:
      consumes:
      - application/json
      description: 定向计划/高佣专场/精选低价包邮/偏远地区包邮/抖货商品/各大榜单商品/今日值得买
      parameters:
      - description: 页码
        in: query
        name: page
        required: true
        type: string
      - description: 页数
        in: query
        name: page_size
        required: true
        type: string
      - description: 分类id(3定向计划/4高佣专场/5精选低价包邮/6偏远地区包邮/7抖货商品/8各大榜单商品/9今日值得买)
        in: query
        name: category_id
        required: true
        type: string
      - description: 渠道
        in: query
        name: pvd
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/md.IndexRecommendList'
      summary: 抖券商品推荐列表
      tags:
      - 抖券
  /api/v1/sign/fast/in:
    post:
      parameters:
      - description: json
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/md.FastLoginRequestBody'
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/md.LoginResponse'
        "400":
          description: '{"code":400001,"data":[],"msg":"请求参数错误"}'
          schema:
            type: string
      summary: 用户手机快速登录
      tags:
      - 登录、注册
  /api/v1/sub_region_list:
    get:
      parameters:
      - description: 上级地区类型:root(查询省级列表)、province（省级ID下的城市）、city（市级id下的区域）
        in: query
        name: parent
        required: true
        type: string
      - description: 上级地区id
        in: query
        name: id
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            items:
              $ref: '#/definitions/hdl.resultItem'
            type: array
        "400":
          description: '{"code":400001,"data":[],"msg":"请求参数错误"}'
          schema:
            type: string
      summary: 获取区域id下的区域
      tags:
      - 地址
  /api/v1/user/address/:id:
    get:
      parameters:
      - description: 地址id
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/model.UserAddress'
        "400":
          description: '{"code":400000,"data":[],"msg":"地址不存在"}'
          schema:
            type: string
      summary: 用户地址详情
      tags:
      - 地址
  /api/v1/user/address/delete/:id:
    post:
      consumes:
      - application/json
      parameters:
      - description: ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
        "400":
          description: '{"code":400000,"data":[],"msg":"地址不存在"}'
          schema:
            type: string
      summary: 用户地址删除
      tags:
      - 地址
  /api/v1/user/address/update:
    post:
      consumes:
      - application/json
      parameters:
      - description: json参数，Id不传为新增
        in: body
        name: '""'
        required: true
        schema:
          $ref: '#/definitions/hdl.updateAddressReq'
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            type: string
        "400":
          description: '{"code":400000,"data":[],"msg":"地址不存在"}'
          schema:
            type: string
      summary: 用户地址新增、编辑
      tags:
      - 地址
  /api/v1/user/addresses:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            items:
              $ref: '#/definitions/model.UserAddress'
            type: array
        "500":
          description: '{"code":500000,"data":[],"msg":"数据库操作失败"}'
          schema:
            type: string
      summary: 用户地址列表
      tags:
      - 地址
securityDefinitions:
  MasterID:
    in: header
    name: MasterID
    type: apiKey
swagger: "2.0"