后端自动化版本管理,再也不用改URL了!
每次升级接口版本时,后端、前端、客户端都是痛苦的:
后端:要兼容旧版客户端,以前的接口不能动啊,又得写新接口、新文档了,唉!
前端:还好,就是版本号到处都是,改起来比较烦。
Android:快点啊产品催需求呢,服务器别停太久。对了你知道编译一次要多久么?泪奔。。。
前端:对对,别停太久。还有文档别再写错了啊,上次你复制粘贴的 v3 害我接口调了半天,原来是 v4 。。。
iOS:我也被坑了。。。
后端:呃,我尽快,写文档会注意的哈。
后端:另外旧域名 http://api.aaa.com/v4 也会一直开着,保证不会像上次那样让3.0客户端请求挂的。
后端:@前端 对了,你们用一个全局的 BASE_URL 存起来,以后改一个地方就好了。
Android:我们就是这么干的嘿嘿!
iOS:我们也是,还是我封装的。
iOS:但问题是往往多个接口版本并存,还是要写好几个BASE_URL,我们这是从BASE_URL_V2到BASE_URL_V4。
Android:唉,这个就没办法了。
前端:我们现在也是这么做的,但之前的那家伙没封装啊,写得到处都是。。。
后端:周哥,升级接口版本好烦啊,你有什么好的办法吗?
周哥:具体说下你的问题。
后端:每次都要写新的接口和文档,服务器也要重启,前端和客户端总是抱怨改域名和文档错误。
项目很赶,文档是复制粘贴的,总是会落下某些地方没改。
但是不复制粘贴吧,你看看这格式,重新写实在是太麻烦了!
周哥:哈哈,以前我们也总是碰到这种问题,现在解决了。试试这个
周哥:https://github.com/TommyLemon/APIJSON
后端:哇,居然还有这么厉害的后端框架啊!我只用过SSH。
周哥:我也是上个月才知道的,朋友推荐的,我试了一周,非常好用,也没啥大的问题,就整到项目中了。
周哥:SSH太重了,老项目中APIJSON主要用来实现新接口,新项目就只用APIJSON了。
后端:可以的。不过它怎么解决版本问题呢?文档里没说啊。
周哥:写在最下面了。 http://39.108.143.172/
后端:可在最外层传版本version来指定使用的版本,不传或 version <= 0 则使用最新版。 ??
周哥:描述确实比较简单,我就问了下作者,他是这么说的:
TommyLemon:
可以在请求时传入一个version来指定使用的接口版本号,例如查询用户隐私信息:
URL: http://39.108.143.172:8080/gets
表单:
{
"Privacy": {
"id": 82001,
"_password": "123456"
},
"tag": "Privacy",
"version": 1
}
而且只需要登录时传一个全局默认version,之后所有需要登录的接口(一般占绝大部分)就都默认用这个了。
{
"type": 0,
"phone": "13000082001",
"password": "123456",
"version": 1
}
所以查询用户隐私信息就可以省略version了:
{
"Privacy": {
"id": 82001,
"_password": "123456"
},
"tag": "Privacy"
}
因为上面传的version和全局默认version一样,所以服务器返回的结果都一样:
{
"Privacy": {
"id": 82001,
"certified": 1,
"phone": 13000082001,
"balance": 8067
},
"code": 200,
"msg": "success"
}
当然如果某个请求需要用到和全局默认version不一样的接口,也可以指定当前的version:
{
"Privacy": {
"id": 82001,
"_password": "123456"
},
"tag": "Privacy",
"version": 2
}
由于第2版接口改了校验配置,所以返回结果就不一样了:
{
"Privacy": {
"id": 82001,
"_password": "123456"
},
"code": 406,
"msg": "Privacy不允许传 _password 等[_password, _payPassword]内的任何字段!"
}
注:这个接口需要登录权限,请先点击右上角登录后再请求。
周哥:我照着这个来,在测试网页一个个试了,确实是这样的。
后端:但还有个问题,项目中可能多个版本并存,它是不是也要同时维护多个版本啊?
周哥:哈哈,以前只有两种做法:
1.前端根据的需求调对应版本的api,后端只新增对应新需求的api。
2.前端只用一个版本,后端对新版不需要改的api v2也提供一个对应新版的api v3,然后和v2一样处理,可以提取v2的代码为一个公共的函数。
或者就干脆重定向到v2,这个操作简单些,但要损失一些性能。
周哥:用APIJSON就只需要把原来旧版的api改下版本号version为一个统一的最新版,请求中传的version如果不存在,则会自动转到比它高的最接近版本。
后端:也就是我把v1,v2都改成v3,然后前端传v1或v2过来,它就转到v3了?如果不改的话还是转到v2?
周哥:对的。如果不传version或version<=0,就会强制用最新版。这个在修复某些api漏洞时很有用,把前端请求中的version去掉或者改成0,就可以了。
后端:我觉得可以直接把api的version改成最新版,这样更简单。
周哥:确实,小伙子你很聪明啊。
后端:哈哈,谢谢周哥,我去试试。
后端:作者很牛啊
周哥:哈哈,我之前也好奇什么人能写出这样的框架。
周哥:接口都不用写了,都是框架自动实现的,话说现在终于没人再催接口了哈哈!
后端:真的很好用啊,以后就让前端客户端都在登录时传一个version就搞定了。
后端:不过项目中还有些不需要登录就能访问的接口,例如注册、找回密码等,这些就只能每次都传一个version了。
周哥:是的,不过绝大部分接口都是要登录后才能访问的啊。
后端:也是啊。
后端:对了,普通的查询请求好像没version的示例啊。
周哥:因为不需要哈哈,作者说GET,HEAD请求都是开放请求,没有版本限制。我试过了确实是这样。
后端:也就是不用传version?
周哥:是的,而且请求非常灵活,可以定制请求的内容、JSON结构,一大堆查询请求的接口都不用自己写了。
后端:这样啊,太棒了,我去Star一下。
后端:@前端 @Android @iOS 新版接口写好了。
后端:大家把新版请求的主域名改成 http://api.aaa.com,以后登录时再传一个version就好了。
{
"version":5
}
前端:这么快?
iOS:这么快?
Android:这么快?
后端:用了新框架嘿嘿!
Android:不用换版本号v5了?
iOS:以后会要加上吗?
后端:不用了,以后也不用 v6,v7 了,域名不会再改了。
iOS:那不需要登录的接口呢?
后端:不用管,这几个接口很稳定,暂时不会动的。
Android:可以的
iOS:赞
前端:厉害,怎么做到的啊?
后端:大家看下这个,我们后端以后的接口都用新框架写。
后端:https://github.com/TommyLemon/APIJSON
iOS:支持
前端:+1
Android:好棒,我也玩一玩后端嘿嘿!
APIJSON - 后端超光速开发框架
Github源码及文档(右上角点Star支持下吧^_^)
https://github.com/TommyLemon/APIJSON
下载客户端(测试服务器地址:http://apijson.cn:8080)
后端自动化版本管理,再也不用改URL了!的更多相关文章
- 教会舍友玩 Git (再也不用担心他的学习)
舍友长大想当程序员,我和他爷爷奶奶都可高兴了,写他最喜欢的喜之郎牌Git文章,学完以后,再也不用担心舍友的学习了(狗头)哪里不会写哪里 ~~~ 一 先来聊一聊 太多东西属于,总在用,但是一直都没整理的 ...
- 保姆级神器 Maven,再也不用担心项目构建搞崩了
今天来给大家介绍一款项目构建神器--Maven,不仅能帮我们自动化构建,还能够抽象构建过程,提供构建任务实现:它跨平台,对外提供了一致的操作接口,这一切足以使它成为优秀的.流行的构建工具,从此以后,再 ...
- 【阿里云产品公测】离线归档OAS,再也不用担心备份空间了
[阿里云产品公测]离线归档OAS,再也不用担心备份空间了 作者:阿里云用户莫须有3i 1 起步 1.1 初识OAS 啥是OAS,请看官方说明: 引用: 开放归档服务(Open Archive Se ...
- 学会这个删库再也不用跑路了~ --技术流ken
前言 相信每一个学IT的人或多或少都听说过从删库到跑路这个梗~下图也是在各种交流群屡禁不止,新人听着也是瑟瑟发抖. 人们茶余饭后,街头巷角难免要问... 下面技术流ken就教给各位新手们一招删库再也不 ...
- 妈妈再也不用担心别人问我是否真正用过redis了
1. Memcache与Redis的区别 1.1. 存储方式不同 1.2. 数据支持类型 1.3. 使用底层模型不同 2. Redis支持的数据类型 3. Redis的回收策略 4. Redis小命令 ...
- 有了这个,再也不用每次连新机器都要设置secure crt属性了
我连服务器用的是secure crt,每次ssh新服务器的时候都得手动设置字符编码和背景颜色,今天问了旁边的开发原来可以全局设置,以后连服务器的时候就再也不用手动设置相关属性了.步骤如下: 一开始点击 ...
- 锋利的js之妈妈再也不用担心我找错钱了
用js实现收银功能. <!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <hea ...
- 有了 tldr,妈妈再也不用担心我记不住命令了
引言 有一次我在培训时说「程序员要善于使用 Terminal 以提高开发效率」,一位程序员反驳道:「这是 21 世纪,我们为什么要用落后的命令行,而不是先进的 GUI?」 是的,在一些人眼里,这个黑黑 ...
- 妈妈再也不用担心我使用git了
妈妈再也不用担心我使用git了 Dec 29, 2014 git git由于其灵活,速度快,离线工作等特点而倍受青睐,下面一步步来总结下git的基本命令和常用操作. 安装msysgit 下载地址:ms ...
随机推荐
- 关于TileBrush中Viewbox,Viewport以及Stretch,AlignmentX/Y的详细研究
我们知道TileBrush是WPF中一个战斗力爆表的虚基类,从它派生出的DrawingBrush,ImageBrush和VisualBrush在WPF图形编程中发挥着重要作用.然而关于TileBrus ...
- Unity 使用 陀螺仪 实现 《王者荣耀》 登入界面 背景动态效果
在 <王者荣耀> 登入界面 左右上下晃动手机(有些手机不支持)可以看到背景在变化 我使用的是iPhone SE 效果如下: 对比两张图片的左下角 可以看到差异 至于为什么要这么做: 1.使 ...
- 根据Dockerfile创建docker dotnet coer 镜像
那我们先来看看Dockerfile文件内容,注意这个文件是没后缀名的. #依赖原始的镜像,因为我们是要创建dotnet coer镜像,所以我就用了官方给的镜像[microsoft/dotnet:lat ...
- MYSQL数据库45道练习题
--第一题查询Student表中的所有记录的Sname.Ssex和Class列.select Sname,Ssex,Class from Student;--第二题查询教师所有的单位即不重复的Depa ...
- 设置QT应用程序图标方法(Windows下)
学习笔记,言简意赅. 1- 新建文本文件,编辑输入 IDI_ICON1 ICON DISCARDABLE "./image/WindowIco.ico" 注意: ...
- [译]ASP.NET Core 2.0 带初始参数的中间件
问题 如何在ASP.NET Core 2.0向中间件传入初始参数? 答案 在一个空项目中,创建一个POCO(Plain Old CLR Object)来保存中间件所需的参数: public class ...
- Windows下MongoDB常用命令
以下命令中的启动与暂停服务命令需要使用管理员身份运行cmd.exe,其他命令需要先cd到Mongodb安装目录的bin目录. 1.启动服务:net start [Mongodb服务名].示例: net ...
- MongoDB监控
1. mongostat:间隔固定时间获取mongodb的当前运行状态,并输出. 使用示例: D:\Program_Files\MongoDB\bin\mongostat(根据MongoDB的安装目录 ...
- 笔记-64位dump转32位dump
下图是从测试拷64位windbg抓的dump文件拖到32位windbg查看线程堆栈信息的效果. 那么我们加载一下wow64exts模块,因为需要这个模块帮助把64位的dump,转换成32位的dump. ...
- Unity3D手机斗地主游戏开发实战(02)_叫地主功能实现(不定期更新中~~~)
目录 Unity3D手机斗地主游戏开发实战(01)_发牌功能实现 Unity3D手机斗地主游戏开发实战(02)_叫地主功能实现 一.大体思路 前面我们实现了点击开始游戏按钮,系统依次给玩家发牌的逻辑和 ...