定义接口常用约定

1.json返回的类型一般情况下和约定的一致。如约定value的类型为string,不要返回int,object类型,如需修改,建议新增key兼容旧版本。 2.value返回值采用具体值类型,如string为空请返回"", 不要返回null, int同理返回具体数值,object返回{},list返回[]。 3.error号返回正确时,保证所携带的数据也是正确的。

转载于:https://www.cnblogs.com/lz465350/p/5148262.html

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Maven约定前后端交互接口主要是通过遵循一些约定定义和管理前后端接口的交互方式。以下是一些常见的约定: 1. 接口路径规范:在前后端分离的开发模式中,通常将前后端接口分别部署在不同的服务器上。为了方便管理和调用接口,可以约定前后端接口路径的命名规范,例如使用/rest作为接口的前缀。 2. 接口参数规范:定义前后端接口参数的命名规范和数据类型。可以使用驼峰命名法来命名参数,同时确保前后端参数的数据类型一致,例如使用字符串、整数、布尔值等。 3. 接口返回结果规范:约定前后端接口返回结果的数据结构和格式。可以使用JSON作为数据格式,定义统一的返回数据结构,包括状态码、消息和数据等字段。同时,可以使用枚举类型来定义一些常用的状态码,如成功、失败等。 4. 接口文档规范:使用工具或框架生成接口文档,方便前后端开发人员查阅和理解接口定义和使用方式。可以通过注释、注解或配置文件等方式将接口信息生成文档,并提供给前后端开发人员进行参考。 5. 接口版本管理:随着项目的迭代和升级,接口可能会发生变化。为了防止接口的兼容性问题,可以使用版本管理机制,如在接口路径中添加版本号,或使用请求头来指定接口版本。 综上所述,Maven约定前后端交互接口是为了提高前后端开发效率和接口管理的一种规范约定方式。通过遵循这些约定,可以减少开发人员之间的沟通成本,提高开发效率,同时也方便后期维护和接口升级。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值