沟通创造价值，分享带来快乐。这里是程序员阅读时间，每天和你分享读书心得，欢迎您每天和我一起精进。今天和大家一起讨论的话题是如何设计一个良好的API接口？


挑战

API是软件系统的核心，而我们在设计API接口的时候会面临着非常多的挑战：

  • 场景上来看，它是多样的，如何设计一个随处适用的API？
  • 我们所参与的业务不断演进的，如何设计一个有兼容性的API？
  • 我们的软件流程是协同开发的，那我们如何实现对API的统一认知？

今天我想和大家探讨一下如何设计一个良好的API接口，我觉得好的API设计需要同时考虑到这几个要素：标准化、兼容性、抽象性、简单性、高性能，可以说这几个要素缺一不可。

Openapi的架构模式 openapi设计_API

标准化

对于Web API标准化而言，一个非常好的案例就是Restful API。目前业界的Open API多数是基于Restful API规范设计的。

1、等级模型

需要注意的是Restful API它具有成熟度的模型。

  • 其中Level 0是普通的请求响应模式。
  • Level 1引入了资源的概念，各个资源可以单独创建URI，与Level 0相比，它通过资源分而治之的方法来处理复杂问题。
  • Level 2引入了一套标准的HTTP协议，它通过遵守HTTP协议定义的动词并配合HTTP响应状态码来规范化Web API的标准。
  • Level 3中，使用超媒体可以使协议拥有自我描述的能力。

通常情况下，成熟度模型中达到Level 2就已经非常好了。

Openapi的架构模式 openapi设计_API_02

2、URI

在Restful API中，每一个URI代表着一种资源，是每一个资源的唯一定位符。所谓资源，它可以是服务器上的一段文本、一个文件、一张图片、一首歌曲，或者是一种服务。

Openapi的架构模式 openapi设计_字段_03

Restful API呢，规定了通过get/post/put/patch/delete等方式对服务端的资源进行操作。

因此，我们在定义一个Web API的时候，需要明确定义出它的请求方式、版本、资源名称和资源ID。

Openapi的架构模式 openapi设计_Openapi的架构模式_04

举个例子，要查看用户编码是101的用户信息，我可以定义get的请求方式，而他的版本是V1，资源名称是users，资源ID是1001。

Openapi的架构模式 openapi设计_字段_05

这里可以思考一下，如果存在多个资源组合的情况呢？

事实上还可引入子资源的概念，需要明确定义出它的请求方式、版本、资源名称与资源ID，以及子资源名称与此资源ID。

Openapi的架构模式 openapi设计_HTTP_06

举个例子，要查看用户编码是101的用户的权限信息，我可以定义get的请求方式。而他的版本是V1，主资源名称是Users，主资源ID是1001子资源名称是Roles，资源ID是101。

Openapi的架构模式 openapi设计_字段_07

有时候，当一个自然变化难以使用标准的Restful API来命名时，就可以考虑使用一些特殊的actions命名。

比如密码修改接口，我可以定义Put的请求方式，而他的版本是V，主资源名称是users，主资源ID是101资源字段是password。然后定义一个action的操作是modify。

Openapi的架构模式 openapi设计_Openapi的架构模式_08

3、错误码和返回机制

与此同时啊，建议不要试图创建自己的错误码和返回错误机制。

很多时候呢，我们觉得提供更多的自定义的错误码有助于传递信息，但其实，如果只是传递信息的话，错误信息字段可以达到同样的效果。

此外，对于客户端来说，很难关注到那么多错误的细节，这样的设计只会让API的处理变得更加复杂，难于理解。

因此，我的建议是遵守Restful API的规范，使用HTTP规范的错误码。例如，我们用200表示请求成功，用400表示错误的请求，而500则表示服务器内部的错误。

Openapi的架构模式 openapi设计_API_09

当Restful API接口出现非200的HTTP错误码响应时，可以采用全局的异常结构响应信息。

4、返回体结构

这里列出了最为常用的几个字段，讲一下它们各自表示的含义。

  • 其中code字段用来表示某类错误的错误码，例如前面介绍的无效请求、缺少参数、未授权资源、未找到资源、已存在的错误。
  • 而message字段用来表示错误的摘要信息，它的作用是让开发人员能快速识别错误。
  • server_time字段，用来记录发送错误时的服务器时间，他可以明确的告诉开发人员发生错误时的具体时间，便于在日志系统中根据时间范围来快速定位错误信息。

Openapi的架构模式 openapi设计_字段_10

此外，不常用字段会根据不同的情况做出有不同的响应。

如果是单条数据，则返回一个对象的json字符串；如果是列表数据，则返回一个封装的结构体，其中涵盖count字段和item字段。

Openapi的架构模式 openapi设计_字段_11

count字段表示返回数据的总数据量。需要注意的是，如果接口没有分页的需求，尽量不要返回这个count字段，因为查询总数据量是耗性能的操作。

此外，item字段表示返回数据列表，他是一个json字符串的数组。

5、小结

总结一下，怎么来理解规范呢？可以说他就是大家约定俗成的标准，如果都遵守这套标准，自然沟通成本也就大大降低了。

兼容性

接着我们再来探讨一下API接口的兼容性。由于我们参与的业务是不断演进的，设计一个有兼容性的API就显得尤为重要了。如果接口不能够向下兼容，业务就会受到很大影响。

例如：

  • 我们的产品是涵盖android、ios、pc端的，都运行在用户的机器上，这种情况下，用户必须升级产品到最新的版本才能够更好的使用。
  • 同时，我们还可能遇到服务端不停机升级，由于API不兼容而遇到短暂的服务故障。

为了实现API的兼容性，我们引入了版本的概念，前面的案例URI中通过保留版本号实现了兼容多个版本。

Openapi的架构模式 openapi设计_Openapi的架构模式_12

举个例子，针对要查看用户编码是1001的用户信息，可以分别定义V1和V2两个版本的API接口，然后分别让他们对应两套不完全兼容的业务逻辑特性。

抽象性

通常情况下，我们的接口抽象都是基于业务需求的，因此我们一方面要定义出清晰的业务问题域模型，例如数据模型和领域模型等，并建立起某个问题的现实映射，这样有利于不同的角色对API设计认知的统一。

另一方面，API设计如果可以实现抽象，就可以很好的屏蔽具体的业务实现细节，为我们提供更好的可扩展性。

简单性

简单性的主要宗旨是遵守最少的知识原则。

怎么来理解呢？其实就是客户端不需要知道那么多服务的API接口，以及这些API接口的调用细节，比如设计模式的外观模式和中介者模式都是它的应用案例。

Openapi的架构模式 openapi设计_字段_13

如图所示，外观接口将多个服务进行业务封装与整合，并提供了一个简单的API调用给客户端使用，这样设计的好处是什么呢？就在于客户端只需要调用这个外观接口就行了，省去了一些繁杂的步骤。

性能

同时，我们还需要关注性能，就比如说外观接口，虽然保证了简单性，但是增加了服务端的业务复杂度，同时，由于多服务之间的聚合，导致他们的接口性能也不是太好。

此外，我们还需要考虑字段的各种组合会不会导致数据库的性能问题。有时，我们可能暴露了太多字段给外部使用，导致数据库没有相应的索引而发生全表扫描。这种情况在查询的场景下非常常见，因此我们可以只提供存在索引的字段组合给外部调用。

Result<Void> agree(Long taskId，Long caseId，Configger configger)

在上面这个代码案例中，要求调用方必填taskId和caseId来保证数据库索引的使用，以进一步保证服务提供方的服务性能。

总结

今天给大家侧重探讨的是如何设计一个良好的API接口。

好的API设计需要我们同时考虑到标准化、兼容性、抽象性、简单性和高性能。

其中，标准化的关键在于尽可能少的创建自定义规范和机制，而是共同遵守业内标准，例如HTTP规范和Restful API规范。

通常情况下，我们会采取版本号来解决多版本的兼容性的问题。

抽象性需要确保能够定义出清晰的问题域模型，尽可能屏蔽具体的业务实现细节。

简单性是相对的，需要遵守最少知识原则，让调用方尽可能少的知道内部的调用细节，性能注意的细节就多了，这里主要强调了业务组合和参数组合场景。

Openapi的架构模式 openapi设计_API_14

 

 

希望以上分享对你有所帮助，感谢您的捧场。