四时宝库

程序员的知识宝库

接口规范之议(接口规范之议是什么)

公司接口协议返回规范:

@Data
public class CommonResponse {

    /**
     *  响应码
     */
    private int code;

    /**
     *  提示
     */
    private String message;

    /**
     * 响应内容
     */
    private Object body;
}

响应体里边包含code、msg、body,其中code取值1和-1,1:表示成功;-1:表示失败

msg可以提供简单提示,body返回后端对象。

现在要做国际化,有两种意见:

  • 意见一:

后端msg里边返回错误码,前端根据错误码引用国际化语言资源。

优点:错误码统一定义,根据服务名称+模块名称+错误码 避免语义混淆

缺点:接口调试需要熟悉服务服务。

  • 意见二:

后端msg返回英文的提示,前端引用国际化语言资源。

优点:可以直观明了知道什么含义

缺点:在业务接口较多的情况下,可能发生含义歧义

发表评论:

控制面板
您好,欢迎到访网站!
  查看权限
网站分类
最新留言
    友情链接