前后端开发接口规范

​📒个人主页:风月知我意📒
​❤️感谢大家阅读本文,同时欢迎访问本人主页查看更多文章​❤️
🙏本人也在学习阶段,如若发现问题,请告知,非常感谢🙏

接口规范

由前端(Web端)和后端一起协定接口规范的内容, 确定每一个接口的地址(URL), 输入(request)和输出(response),,同时详细注释每一个字段的含义和数据类型.
具体需要定义那些接口可以按照下面的约定:

  • 资源接口:(例如:获取所有院校信息、新建院校信息)按照RESTful风格定义
  • 操作接口:(例如:登录)如果可以使用restful风格就使用RESTful风格
  • 页面接口:(例如:进入首页时候)这个页面存在许多的接口,如果一个个调用影响性能,因此需要将这些接口的数据汇总在一起新建一个聚合接口

RESTful风格

概念:一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。

<
请求方式 举例 含义
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
后端分离的开发中,以下是一些常见的开发规范: 1. 接口规范: - 使用 RESTful 风格来设计和命名接口。 - 使用 HTTP 动词(GET、POST、PUT、DELETE)来定义接口的操作类型。 - 使用合适的状态码来表示接口的执行结果。 - 对于请求参数和响应结果,使用 JSON 格式进行数据交互。 2. 代码规范: - 遵循统一的命名规范,如使用驼峰命名法或下划线命名法。 - 使用合适的缩进和代码格式化,增强代码的可读性。 - 注释代码,解释代码的功能和实现方式。 - 模块化开发,尽量避免出现过长或过于复杂的函数或类。 3. 安全规范: - 对用户输入进行有效的验证和过滤,防止注入攻击和跨站脚本攻击(XSS)。 - 使用安全的加密算法对敏感数据进行加密存储。 - 在端和后端都进行权限校验,防止未授权访问和越权操作。 4. 性能规范: - 减少网络传输大小,使用 gzip 压缩响应结果。 - 启用浏览器缓存,减少重复请求。 - 合理使用数据库查询,避免频繁的查询和不必要的数据加载。 - 使用异步请求和加载,提高用户体验。 5. 版本控制和团队协作: - 使用版本控制工具,如 Git,对代码进行管理和协作开发。 - 遵循代码审查的流程,提高代码质量和可维护性。 - 使用项目管理工具,如 Jira,进行任务分配和进度跟踪。 以上是一些常见的后端分离开发规范,具体的规范可以根据团队实际情况和项目需求进行调整和补充。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值