开发者必备——API设计问题

本文主要探讨RPC和RESTFul两种API风格的特点以及在开发中应该如何进行技术选型，截取了部分网上社区，文章关于API设计的想法和观点供读者参考取舍。

1，背景简述

API学名：应用程序接口（Application Programming Interface）

通俗的打个比方，人与人之间通过语言来交流，而程序和程序之间通过API来交流。

目前市场主流的API设计包括RPC，RESTFul，GraphQL等设计思路，关于API风格优劣，好坏众说纷纭，但客观来说：RPC资历最老，并沿用至今，RESTFul后来者居上，火了好大一阵，最新的GraphQL据说会在Githup下一版投入使用。API的选择问题丝毫不亚于跨端框架Flutter和RN的激烈斗争。但笔者坚持认为：软件开发没有银弹，技术终究会被历史裹挟，不断推进，但对于开发者来说，也许没有永恒的银弹，但在当下选择适合自己业务场景的技术却是举足轻重。

本篇文章主要探讨前两种API设计的优缺点以供读者进行技术决策的参考。

2，RPC以动词为核心

2.1 命名风格

RPC 形式的API通常是动宾结构：

getUserInfo，createUser，getUserById

由于接口的个性化需求，添加新功能时，API中可能会引入其他的动词或介词如By，With，create等等，这也是RESTFul征讨RPC的主要原因

• 一是嫌它丑
• 二是认为它不够通用（在服务端更新了之后，客户端也需要阅读文档，适应服务端）

2.2 常用实践

• 面向接口编程

  在参数传递过程中使用接口而不是实现类，使程序更加灵活可扩展

  例如使用Map而不是HashMap，TreeMap，使用List而不是ArrayList，LinkedList

• 方法重载

  通俗来讲，省去了方法名，使得AP