ErrorRulesDoc - marmot-cn/marmot-framework GitHub Wiki

错误规范

概述

用于提前编写约束错误说明, 一般和控件规范文档一一对应, 同时和代码中的错误规范对应.

错误规范示例

ER-数字

id

错误的唯一id

code

程序用的错误状态码,用字符串表述

title

简短的,可读性高的问题总结.

detail

针对该问题的高可读性解释

links

可以在请求文档中取消应用的关联资源


  • ER-1001: 新闻类型不存在
  • ER-1002: 数据纬度不存在
  • ER-5002 - ER-6000: 新闻类错误预留

ER-1001

id

1001

code

NEWS_TYPE_NOT_EXIST

title

新闻类型不存在

detail

新闻类型不存在

links

待补充

ER-1002

id

1002

code

DIMENSION_NOT_EXIST

title

数据纬度不存在

detail

数据纬度不存在

links

待补充

ER-1002 - ER-2000

用户通用错误预留字段