点击上方“芋道源码”,选择“设为星标”
管她前浪,还是后浪?
能浪的浪,才是好浪!
每天 10:33 更新文章,每天掉亿点点头发...
源码精品专栏
在设计接口时,有很多因素要考虑,如接口的业务定位,接口的安全性,接口的可扩展性、接口的稳定性、接口的跨域性、接口的协议规则、接口的路径规则、接口单一原则、接口过滤和接口组合等诸多因素,本篇文章将简要分析这些因素。
在设计接口时,必须明确接口的职责,即接口类型,接口应解决什么业务问题等
在明确接口职责的条件下,尽量做到接口单一,即一个接口只做一件事,而非两件以上。很多非资深接口设计者,在设计接口时,总认为接口所做的事越多,越牛叉,这是非常严重的错误认识。
在设计接口时,应明确接口协议,是采用HTTP协议,HTTPS协议还是FTP协议,要根据具体情况来定。
由于api获取的是一种资源,所以网址中尽量为名词,而非动词
/api/v1.0/pruduct/2019 /api/v1.0/users/2019
接口基本访问协议:get(获取),post(新增),put(修改)和delete(删除)
一般地,域名分为主域名和专有域名,主域名适合api长期不变或变化较少的业务,专有域名是解决具体的专有业务的
(1)主域名:www.baidu.com
(2)产品服务类
(3)市场活动类
在明确域名的情况下,一定要考虑接口是否跨域,以及跨域应采用的技术手段等。
对于接口的url,应加版本号http://api.demo.com/v{d}/,如 ,其中d表示版本号,如v1.0,v2.0
例子:获取产品号为2019,版本号为v1.0的版本号的产品信息
/api/v1.0/Pruducts/2019
当记录数比较多时(如 SELECT * FROM TBName),因适当添加一些条件对数据进行过滤,如TOP,分页,分组,排序和WHERE条件等
返回数据格式,一般包括三个字段:
(1)失败情况(状态码、错误码和错误描述)
{
“status”:0,//状态码 0-表示失败,1-表示成功
“error_code”:”2003”,//错误码,一般在设计时定义
“error_des”:”身份验证失败”//错误描述,一般在设计时定义
}
(2)成功情况(标识id,数据对象,状态码)
{
”sid“:”sh20190111”,//token id
”users“:{
”id“:”al201901111341”,//用户id
“name”:”Alan_beijing”,//用户名
“addr”:”用户地址”
},
“status”:1//状态码 0-表示失败,1-表示成功
}
接口暴露的考虑,接口并发量的考虑,接口防攻击的考虑,接口跨域的考虑等
在设计接口时,充分考虑接口的可扩展性。
任何api,从权限上,可归结为匿名api和非匿名api,前者不需要验证,后者需要验证
在api设计时,要定好api返回码,如
基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能。 项目地址:https://github.com/YunaiV/ruoyi-vue-pro
存在这样一种业务场景:某个接口需要返回多个api接口组合的结果 ,在类似的业务场景下,所设计的接口,具有一定的反规范性。
data:[
{url:'api1',type:'get',data:{...}},
{url:'api2',type:'get',data:{...}},
]
{
status:0,
msg:'',
data:[
{status:1,msg:'',data:[]},
{status:1,msg:'',data:{}}
]
}
基于微服务的思想,构建在 B2C 电商场景下的项目实战。核心技术栈,是 Spring Boot + Dubbo 。未来,会重构成 Spring Cloud Alibaba 。 项目地址:https://github.com/YunaiV/onemall
假设存在这样一个一个业务:一个ERP系统,需要提供两个接口,一个是用户访问接口(需要验证),另一个是用户注册接口(不需要验证)。
根据本篇文章一,二部分的建议,我们来设计满足该业务需求的接口
如下为定义接口授权类别
Request:
{
"mobile":13636595499,
"verify_code":"987654",
"pwd":"123456"
}
Responce:
(1)error
{
"status":0,
"error_code":1001,
"error_desc":"手机验证码已失效"
}
(2)succed
{
"sid":"sh201901141529",
"uid":1,
"status":1
}
Responce:
1.error
{
"status":0,
"error_code":1002,
"error_desc":"密码错误"
}
2.succeed
{
"sid":"sh201901141529",
"user":{
"id":1,
"username":"",
age:0,
gender:0
},
"status":1
}
欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:
已在知识星球更新源码解析如下:
最近更新《芋道 SpringBoot 2.X 入门》系列,已经 101 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。
提供近 3W 行代码的 SpringBoot 示例,以及超 4W 行代码的电商微服务项目。
获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。
文章有帮助的话,在看,转发吧。谢谢支持哟 (*^__^*)