响应格式

接口的返回格式统一为

  1. {
  2.     "code": 200,
  3.     "data": [],
  4.     "msg": "",
  5. }

异常

系统内置了基本异常，您可以按需取用

  1. ./vendor/mochat/framework/src/Exception
  2. ├── CommonException.php
  3. └── Handler
  4.    ├── AuthExceptionHandler.php
  5.    ├── CommonExceptionHandler.php
  6.    ├── ErrorExceptionHandler.php
  7.    ├── GuzzleRequestExceptionHandler.php
  8.    └── ValidationExceptionHandler.php

错误码

系统同样已经定义了基本的错误码，如下。

  1. <?php
  3. declare(strict_types=1);
  5. namespace MoChat\Framework\Constants;
  7. use Hyperf\Constants\AbstractConstants;
  8. use Hyperf\Constants\Annotation\Constants;
  10. /**
  11.  * 错误code
  12.  * 3位HTTP码 + 6位业务码[前3位为模块，后3位为业务]
  13.  * 有其它错误码需求，即使补充
  14.  * 业务模块码:
  15.  * 100  -  公共模块
  16.  * 100  -  授权模块
  17.  * 200  -  通讯录模块
  18.  * 300  -  外部联系人模块
  19.  * 301  -  外部联系人 - 高级属性模块
  20.  * 400  -  会话内容存档模块.
  21.  * @Constants
  22.  * @method static string getMessage(int $code)  获取错误码信息
  23.  * @method static int getHttpCode(int $code) 获取错误码的httpCode
  24.  */
  25. class ErrorCode extends AbstractConstants
  26. {
  27.     /**
  28.      * @Message("token失效")
  29.      * @HttpCode("401")
  30.      */
  31.     const TOKEN_INVALID = 100001;
  33.     /**
  34.      * @Message("用户或密码错误")
  35.      * @HttpCode("401")
  36.      */
  37.     const AUTH_LOGIN_FAILED = 100002;
  39.     /**
  40.      * @Message("非法token")
  41.      * @HttpCode("401")
  42.      */
  43.     const AUTH_TOKEN_INVALID = 100003;
  45.     /**
  46.      * @Message("token过期")
  47.      * @HttpCode("401")
  48.      */
  49.     const AUTH_SESSION_EXPIRED = 100004;
  51.     /**
  52.      * @Message("未认证,没有token")
  53.      * @HttpCode("401")
  54.      */
  55.     const AUTH_UNAUTHORIZED = 100005;
  57.     /**
  58.      * @Message("认证失败")
  59.      * @HttpCode("401")
  60.      */
  61.     const AUTH_FAILED = 100006;
  63.     /**
  64.      * @Message("没有权限")
  65.      * @HttpCode("403")
  66.      */
  67.     const ACCESS_DENIED = 100007;
  69.     /**
  70.      * @Message("拒绝客户端请求")
  71.      * @HttpCode("403")
  72.      */
  73.     const ACCESS_REFUSE = 100008;
  75.     /**
  76.      * @Message("禁止重复操作")
  77.      * @HttpCode("403")
  78.      */
  79.     const NO_REPETITION_OPERATION = 100009;
  81.     /**
  82.      * @Message("客户端错误")
  83.      * @HttpCode("400")
  84.      */
  85.     const BAD_REQUEST = 100010;
  87.     /**
  88.      * @Message("非法的Content-Type头")
  89.      * @HttpCode("401")
  90.      */
  91.     const INVALID_CONTENT_TYPE = 100011;
  93.     /**
  94.      * @Message("资源未找到")
  95.      * @HttpCode("404")
  96.      */
  97.     const URI_NOT_FOUND = 100012;
  99.     /**
  100.      * @Message("非法的参数")
  101.      * @HttpCode("422")
  102.      */
  103.     const INVALID_PARAMS = 100013;
  105.     /**
  106.      * @Message("服务器异常")
  107.      * @HttpCode("500")
  108.      */
  109.     const SERVER_ERROR = 100014;
  111.     /**
  112.      * @Message("服务器异常(third-party-api)")
  113.      * @HttpCode("500")
  114.      */
  115.     const THIRD_API_ERROR = 100015;
  116. }