video_course/docs/swagger.yaml

basePath: /v1
definitions:
  controller.ResponseBase:
    properties:
      code:
        type: integer
      memo:
        type: string
    type: object
  controller.ResponseVerifyPic:
    properties:
      id:
        type: string
      pic:
        type: string
    type: object
  controller.UserList:
    properties:
      code:
        type: integer
      memo:
        type: string
      rs:
        items:
          type: object
        type: array
    type: object
info:
  contact:
    email: support@swagger.io
    name: API Support
    url: http://www.swagger.io/support
  description: Video Course框架 API 文档
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://swagger.io/terms/
  title: Video Course框架
  version: "1.0"
paths:
  /Auth/GenVerifyPic:
    post:
      consumes:
      - application/x-www-form-urlencoded
      description: 获取验证图片和验证id
      parameters:
      - description: 高
        in: formData
        name: height
        required: true
        type: string
      - description: 宽
        in: formData
        name: width
        required: true
        type: string
      - description: 噪点数量
        in: formData
        name: noiseCount
        required: true
        type: string
      - description: 验证码字数
        in: formData
        name: length
        required: true
        type: string
      - description: 验证码取值范围 比如  1234567890 或者 abcdef等
        in: formData
        name: source
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/controller.ResponseVerifyPic'
      summary: 获取验证图片
      tags:
      - Auth
  /Auth/GetPhoneVFCode:
    post:
      consumes:
      - application/x-www-form-urlencoded
      description: 手机获取验证码
      parameters:
      - description: 手机号
        in: formData
        name: phone
        required: true
        type: string
      - description: 验证码类型 1:登录
        in: formData
        name: codeType
        required: true
        type: integer
      - description: 图形验证码id
        in: formData
        name: picId
        required: true
        type: string
      - description: 图形验证码
        in: formData
        name: picCode
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/controller.ResponseBase'
      summary: 手机获取验证码
      tags:
      - Auth
  /Auth/PhoneSignIn:
    post:
      consumes:
      - application/x-www-form-urlencoded
      description: 手机验证码登录
      parameters:
      - description: 手机号
        in: formData
        name: phone
        required: true
        type: string
      - description: 验证码
        in: formData
        name: smsCode
        required: true
        type: integer
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/controller.ResponseBase'
      summary: 手机验证码登录
      tags:
      - Auth
  /Test/UserAdd:
    post:
      consumes:
      - application/x-www-form-urlencoded
      description: 会员用户添加
      parameters:
      - description: 姓名
        in: formData
        name: name
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/controller.ResponseBase'
      summary: 会员用户添加
      tags:
      - Test
  /Test/UserListQuery:
    post:
      consumes:
      - application/x-www-form-urlencoded
      description: 会员用户查询
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/controller.UserList'
      summary: 会员用户查询
      tags:
      - Test
  /User/UserSelfQuery:
    post:
      consumes:
      - application/x-www-form-urlencoded
      description: 会员信息查询
      parameters:
      - description: Token
        in: formData
        name: token
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/controller.ResponseBase'
      summary: 会员信息查询
      tags:
      - User
securityDefinitions:
  ApiKeyAuth:
    in: header
    name: Authorization
    type: apiKey
  BasicAuth:
    type: basic
  OAuth2AccessCode:
    authorizationUrl: https://example.com/oauth/authorize
    flow: accessCode
    scopes:
      admin: ' Grants read and write access to administrative information'
    tokenUrl: https://example.com/oauth/token
    type: oauth2
  OAuth2Application:
    flow: application
    scopes:
      admin: ' Grants read and write access to administrative information'
      write: ' Grants write access'
    tokenUrl: https://example.com/oauth/token
    type: oauth2
  OAuth2Implicit:
    authorizationUrl: https://example.com/oauth/authorize
    flow: implicit
    scopes:
      admin: ' Grants read and write access to administrative information'
      write: ' Grants write access'
    type: oauth2
  OAuth2Password:
    flow: password
    scopes:
      admin: ' Grants read and write access to administrative information'
      read: ' Grants read access'
      write: ' Grants write access'
    tokenUrl: https://example.com/oauth/token
    type: oauth2
swagger: "2.0"