API接口开发规范

整体规范建议采用Restful方式来实施。

协议:API与用户的通信协议,应该使用https协议,确保交互数据的安全传输。

域名:应该尽量将API部署在专用域名下。如:https://api.example.com

api版本控制:
方法一:将API的版本号放入URI,如:https://api.example.com/v1。
方法二:将版本号放在http头信息中。这种方法不如放入url中方便和直观。
采用多版本并存,增量发布的方式,v{n}n代表版本号,分为整形和浮点型。
整形的版本号:大功能发布的版本,改动比较多。
浮点型:小版本号,只增加或修改了很小一部分东西。

api路径规则:
路径又称"终点"(endpoint),表示API的具体网址。在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词。

HTTP请求方式:
对于资源的具体操作类型,由http的动词表示。
常用的HTTP动词有下面四个(括号里是对应的SQL命令)。
GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PU

  • 2
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值