Android开发规范：API接口通用设计规范(1)

| 参数名 | 参数类型 | 是否必填 | 描述 |

| — | — | — | — |

| name | String | 是 | 姓名 |

| password | String | 是 | 密码 |

一个完整的URL如下（以传统URL格式为例）：

https://www.example.com/api/v1/getUserInfo.do?nonce=3ec934e8-81b9-492e-933d-a5dc41eb15bd&timestamp=1567118072&sign=c1741210c06f3827d1d2f3bfd1f1fc2878377307&accessToken=LvzFEeQSuU9B4DrnoPO9D4CL3ZhKCetZ%2FRckCWQlgb9qmNLmgCKxkymoC4pEs5LFw1lSAGZXKvHe%0AvpFgXKmAAQ%3D%3D&appKey=3b6af23db66c69b7131a8186f90fe663&name=jack&password=123456

返回值

---

使用Json格式（而不是XML）返回API请求结果。Json格式简洁，传输数据量小，而且能展示复杂的数据结构。

{

“body”:{

},

“code”:0,

“msg”:“”

}

code：API接口执行状态，比如0表示成功，-100表示网络超时，-200表示鉴权失败等等；

msg：非成功状态下，需要说明的信息，一般这个是服务器和code状态码一一对应定义；

body：返回的具体数据，也是Json格式。

客户端需要对所有code的值进行一一处理。

接口变更

---

一般来说一个API接口投入使用后，除非这个接口确定废弃不再使用，一般情况下不能对这个接口进行修改，比如API的请求参数和返回值，否则会对使用此API接口的APP带来不可预估的影响，最严重的就是崩溃。

如果接口需要变更，那我们需要保证API接口的变更能够向下兼容，就是API的变更不影响原有使用API接口的客户端。

如果不能够保证向下兼容，那么只有新建新的API接口。

接口变更有以下两种情况：能够向下兼容、不能兼容需要新建新的API接口。

以下是一个原始的json格式的返回值：

{

“id”: 1,

“name”: “jack”,

“address”: “usa”

}

原始URL：https://www.example.com/api/v1/userinfo

1. 向下兼容

(1)url的请求参数新增字段，比如

https://www.example.com/api/v1/userinfo?currentTime=2019/12/12

新增一个请求参数currentTime，不影响当前API接口的使用。

(2)url的返回数据结构增加字段，比如：

{

“id”: 1,

“name”: “jack”,

“address”: “usa”

“age”: 18

}

增加一个age字段，旧版本app只会需要id、name、address三个字段，多出来的age字段对它们来说没有用处，也不会额外处理。而新版本的app使用到这个接口时，可以对这四个字段进行解析，将新增加的age字段利用起来。

2. 新建新的API接口

如果返回的数据格式字段值类型发生了变化，比如age原先是数字类型，值为18，现在改为字符串类型，值为“18”，这样旧版本解析的时候可能就会出错，影响使用。

{

“id”: 1,

“name”: “jack”,

“address”: “usa”

“age”: “18”

}

或者直接将age这个字段的名称改变了，变成year；或者直接将age这个字段给删除掉了。

这些情况对当前使用这个api的app来说一定会产生影响，所以如果出现这种情况需要新增一个新的接口，而不是在原有的接口上修改。

API格式

===============================================================

传统格式

---

示例：

https://www.example.com/getUserInfo.do?id=10000&netType=wifi

API通过具体的业务地址（getUserInfo.do）和请求参数（id=10000&netType=wifi）拼装而成。

请求类型一般就get和post两种，而且有时候在实际项目中这两种类型的请求并没有区分的很明细，而是都可以使用。

RestFul API

---

最后

我见过很多技术leader在面试的时候，遇到处于迷茫期的大龄程序员，比面试官年龄都大。这些人有一些共同特征：可能工作了5、6年，还是每天重复给业务部门写代码，工作内容的重复性比较高，没有什么技术含量的工作。问到这些人的职业规划时，他们也没有太多想法。

其实30岁到40岁是一个人职业发展的黄金阶段，一定要在业务范围内的扩张，技术广度和深度提升上有自己的计划，才有助于在职业发展上有持续的发展路径，而不至于停滞不前。

不断奔跑，你就知道学习的意义所在！

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

需要这份系统化学习资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！