prdUploader/docs/swagger.yaml

definitions:
  dapi.ResponseCommon:
    properties:
      code:
        description: 返回Code 200 成功 其他是失败
        type: integer
      count:
        description: 条数
        type: integer
      message:
        description: 返回信息
    type: object
  login.SsoLoginParams:
    properties:
      mobile:
        description: 登陆手机号
        type: string
      passWord:
        description: 密码
        type: string
    type: object
  login.SsoLoginResponse:
    properties:
      code:
        description: 返回Code 200 成功 其他是失败
        type: integer
      count:
        description: 条数
        type: integer
      data:
        description: 数据列表
        properties:
          token:
            description: 返回token
            type: string
        type: object
      message:
        description: 返回信息
    type: object
  login.SsoRegisterParams:
    properties:
      captcha:
        description: 验证码
        type: string
      email:
        description: 邮箱（可选）
        type: string
      invite:
        description: 邀请码（可选）
        type: string
      mobile:
        description: 手机号
        type: string
      password:
        description: 密码
        type: string
    type: object
  login.SsoRegisterResponse:
    properties:
      code:
        description: 返回Code 200 成功 其他是失败
        type: integer
      count:
        description: 条数
        type: integer
      data:
        properties:
          token:
            type: string
        type: object
      message:
        description: 返回信息
    type: object
  login.SsoSendSmsCodeParams:
    properties:
      mobile:
        type: string
    type: object
info:
  contact: {}
paths:
  /api/v1/login/captcha:
    post:
      consumes:
      - application/json
      description: 该接口用于发送短信验证码，限制验证码的发送频率和每天发送的次数。
      parameters:
      - description: 发送短信验证码的请求参数
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/login.SsoSendSmsCodeParams'
      produces:
      - application/json
      responses:
        "200":
          description: 短信验证码发送成功
          schema:
            $ref: '#/definitions/dapi.ResponseCommon'
      summary: 发送短信验证码
      tags:
      - sms
  /api/v1/login/login:
    post:
      consumes:
      - application/json
      description: 该接口用于用户通过手机号和密码进行登录。如果登录失败，系统会记录错误信息并限制登录次数。
      parameters:
      - description: 用户登录信息
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/login.SsoLoginParams'
      produces:
      - application/json
      responses:
        "200":
          description: 登录成功返回Token
          schema:
            $ref: '#/definitions/login.SsoLoginResponse'
      summary: 用户登录
      tags:
      - login
  /api/v1/login/register:
    post:
      consumes:
      - application/json
      description: 该接口用于用户通过手机号、密码、验证码等信息进行注册。如果注册成功，返回用户的Token。
      parameters:
      - description: 用户注册信息
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/login.SsoRegisterParams'
      produces:
      - application/json
      responses:
        "200":
          description: 注册成功返回Token
          schema:
            $ref: '#/definitions/login.SsoRegisterResponse'
      summary: 用户注册
      tags:
      - register
swagger: "2.0"