接口开发基本规范

一、背景

由于进入了外包公司,且相比于我之前的公司,对代码规范要求还是比较严格的。无论是对代码,还是接口请求方式,参数命名都有要求,虽然之前也有这些意识,但是因为没有经常实践,所以也会渐渐淡忘。所以为了加强规范,也会在这篇文章持续记录开发的基本规范。

二、规范事项

接口规范

1、Get与Post请求方法

  • Get修饰不修改资源的方法,比如查询
  • Post修饰修改资源的方法,比如创建、修改、删除等

至于其它的option、put那些,一般我们不会用,只用get、post表示已经可以覆盖全部场景了

2、路径参数与body参数

  • 路径参数用于标识资源或指定唯一标识符,通过URL的路径部分传递。
  • 查询参数用于传递额外的请求参数,通过URL的查询字符串部分传递。

总结

开发基本规范,也有助于自己的底子与开发素养,基本的东西很重要,用到它们的意识也很重要。
这篇接口开发基本规范,我会持续更新,我不会记录很细的细节,我只会记录基本但却很重要的规范。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值