owl-admin/.scribe/endpoints/00.yaml

name: Endpoints
description: ''
endpoints:
  -
    httpMethods:
      - GET
    uri: 'api/scribe/update-token/{mobile}'
    metadata:
      groupName: Endpoints
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: 更新API文档的认证Token
      description: 通过手机号获取验证码并登录，然后更新API文档的认证Token
      authenticated: true
      custom: []
    headers:
      Authorization: 'Bearer 70|nUrmG4YMAXfrsQpjgxCp9TYu4ifnPRLxvIUV9jgc4ad47df3'
    urlParameters:
      mobile:
        name: mobile
        description: 手机号码.
        required: true
        example: '13800138000'
        type: string
        enumValues: []
        exampleWasSpecified: true
        nullable: false
        custom: []
    cleanUrlParameters:
      mobile: '13800138000'
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters: []
    cleanBodyParameters: []
    fileParameters: []
    responses:
      -
        status: 200
        content: |-
          {
            "code": 200,
            "message": "Token更新成功",
            "data": {
              "token": "your_new_token_here"
            }
          }
        headers: []
        description: ''
        custom: []
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer Bearer {YOUR_AUTH_KEY}'
    controller: null
    method: null
    route: null
    custom: []
  -
    httpMethods:
      - POST
    uri: api/account/send-code
    metadata:
      groupName: Endpoints
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: '[账户管理] 发送验证码'
      description: 向指定手机号发送验证码
      authenticated: true
      custom: []
    headers:
      Authorization: 'Bearer 70|nUrmG4YMAXfrsQpjgxCp9TYu4ifnPRLxvIUV9jgc4ad47df3'
      Content-Type: application/json
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters:
      mobile:
        name: mobile
        description: 手机号码.
        required: true
        example: '13800138000'
        type: string
        enumValues: []
        exampleWasSpecified: true
        nullable: false
        custom: []
    cleanBodyParameters:
      mobile: '13800138000'
    fileParameters: []
    responses:
      -
        status: 200
        content: |-
          {
            "code": 200,
            "message": "验证码发送成功",
            "data": null
          }
        headers: []
        description: ''
        custom: []
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer Bearer {YOUR_AUTH_KEY}'
    controller: null
    method: null
    route: null
    custom: []
  -
    httpMethods:
      - POST
    uri: api/account/login
    metadata:
      groupName: Endpoints
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: '[账户管理] 用户登录'
      description: 使用手机号和验证码登录账户
      authenticated: true
      custom: []
    headers:
      Authorization: 'Bearer 70|nUrmG4YMAXfrsQpjgxCp9TYu4ifnPRLxvIUV9jgc4ad47df3'
      Content-Type: application/json
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters:
      mobile:
        name: mobile
        description: 手机号码.
        required: true
        example: '13800138000'
        type: string
        enumValues: []
        exampleWasSpecified: true
        nullable: false
        custom: []
      code:
        name: code
        description: 验证码.
        required: true
        example: '123456'
        type: string
        enumValues: []
        exampleWasSpecified: true
        nullable: false
        custom: []
    cleanBodyParameters:
      mobile: '13800138000'
      code: '123456'
    fileParameters: []
    responses:
      -
        status: 200
        content: |-
          {
            "code": 200,
            "message": "登录成功",
            "data": {
              "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
              "user": {
                "id": 1,
                "mobile": "13800138000",
                "nickname": "用户昵称"
              }
            }
          }
        headers: []
        description: ''
        custom: []
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer Bearer {YOUR_AUTH_KEY}'
    controller: null
    method: null
    route: null
    custom: []
  -
    httpMethods:
      - POST
    uri: api/account/wx-login
    metadata:
      groupName: Endpoints
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: '[账户管理] 微信登录'
      description: 使用微信openid登录账户
      authenticated: true
      custom: []
    headers:
      Authorization: 'Bearer 70|nUrmG4YMAXfrsQpjgxCp9TYu4ifnPRLxvIUV9jgc4ad47df3'
      Content-Type: application/json
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters:
      openid:
        name: openid
        description: 微信openid.
        required: true
        example: wx_123456789
        type: string
        enumValues: []
        exampleWasSpecified: true
        nullable: false
        custom: []
    cleanBodyParameters:
      openid: wx_123456789
    fileParameters: []
    responses:
      -
        status: 200
        content: |-
          {
            "code": 200,
            "message": "登录成功",
            "data": {
              "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
              "user": {
                "id": 1,
                "openid": "wx_123456789",
                "nickname": "微信昵称"
              }
            }
          }
        headers: []
        description: ''
        custom: []
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer Bearer {YOUR_AUTH_KEY}'
    controller: null
    method: null
    route: null
    custom: []
  -
    httpMethods:
      - POST
    uri: api/account/logout
    metadata:
      groupName: Endpoints
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: '[账户管理] 用户退出'
      description: 退出当前账户登录状态
      authenticated: true
      custom: []
    headers:
      Authorization: 'Bearer 70|nUrmG4YMAXfrsQpjgxCp9TYu4ifnPRLxvIUV9jgc4ad47df3'
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters: []
    cleanBodyParameters: []
    fileParameters: []
    responses:
      -
        status: 200
        content: |-
          {
            "code": 200,
            "message": "退出成功",
            "data": null
          }
        headers: []
        description: ''
        custom: []
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer Bearer {YOUR_AUTH_KEY}'
    controller: null
    method: null
    route: null
    custom: []
  -
    httpMethods:
      - DELETE
    uri: api/account
    metadata:
      groupName: Endpoints
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: '[账户管理] 用户注销'
      description: 永久注销当前账户
      authenticated: true
      custom: []
    headers:
      Authorization: 'Bearer 70|nUrmG4YMAXfrsQpjgxCp9TYu4ifnPRLxvIUV9jgc4ad47df3'
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters: []
    cleanBodyParameters: []
    fileParameters: []
    responses:
      -
        status: 200
        content: |-
          {
            "code": 200,
            "message": "注销成功",
            "data": null
          }
        headers: []
        description: ''
        custom: []
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer Bearer {YOUR_AUTH_KEY}'
    controller: null
    method: null
    route: null
    custom: []
  -
    httpMethods:
      - POST
    uri: api/user/withdraw
    metadata:
      groupName: Endpoints
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: '[用户管理] 用户提现'
      description: 提现用户的余额
      authenticated: true
      custom: []
    headers:
      Authorization: 'Bearer 70|nUrmG4YMAXfrsQpjgxCp9TYu4ifnPRLxvIUV9jgc4ad47df3'
      Content-Type: application/json
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters:
      amount:
        name: amount
        description: 提现金额.
        required: false
        example: '100.00'
        type: decimal
        enumValues: []
        exampleWasSpecified: true
        nullable: false
        custom: []
    cleanBodyParameters:
      amount: '100.00'
    fileParameters: []
    responses:
      -
        status: 200
        content: |-
          {
            "code": 200,
            "message": "提现成功",
            "data": null
          }
        headers: []
        description: ''
        custom: []
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer Bearer {YOUR_AUTH_KEY}'
    controller: null
    method: null
    route: null
    custom: []
  -
    httpMethods:
      - POST
    uri: api/user/feedback
    metadata:
      groupName: Endpoints
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: '[用户管理] 用户反馈'
      description: 提交用户的反馈信息
      authenticated: true
      custom: []
    headers:
      Authorization: 'Bearer 70|nUrmG4YMAXfrsQpjgxCp9TYu4ifnPRLxvIUV9jgc4ad47df3'
      Content-Type: application/json
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters:
      content:
        name: content
        description: 反馈内容.
        required: false
        example: 这是一个反馈信息
        type: string
        enumValues: []
        exampleWasSpecified: true
        nullable: false
        custom: []
    cleanBodyParameters:
      content: 这是一个反馈信息
    fileParameters: []
    responses:
      -
        status: 200
        content: |-
          {
            "code": 200,
            "message": "提交成功",
            "data": null
          }
        headers: []
        description: ''
        custom: []
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer Bearer {YOUR_AUTH_KEY}'
    controller: null
    method: null
    route: null
    custom: []
  -
    httpMethods:
      - POST
    uri: api/user/apply-coach
    metadata:
      groupName: Endpoints
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: '[用户管理] 申请成为技师'
      description: 申请成为技师
      authenticated: true
      custom: []
    headers:
      Authorization: 'Bearer 70|nUrmG4YMAXfrsQpjgxCp9TYu4ifnPRLxvIUV9jgc4ad47df3'
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters: []
    cleanBodyParameters: []
    fileParameters: []
    responses:
      -
        status: 200
        content: |-
          {
            "code": 200,
            "message": "申请成功",
            "data": null
          }
        headers: []
        description: ''
        custom: []
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer Bearer {YOUR_AUTH_KEY}'
    controller: null
    method: null
    route: null
    custom: []