API 入门 (21) 转换目标为API——操作、参数和返回值

接着上一篇文章的内容，继续进行 API 目标到 REST API 的转换。

1. 找出资源及其关系
2. 分析资源的操作
3. 设计资源路径
4. 表示为 HTTP 方法

识别操作

REST API 通过对资源的操作表示其目标。要在一个目标中找到对资源的操作，就要分析并找出目标中的关键动词。然后，把这一个操作与相应的资源进行连接。

识别操作

在上图中，有一点需要注意。在目录中查询自行车和添加自行车到目录两个目标中，，每个 添加 和 查询 操作对应着两个资源。是不是需要把每个操作与两个资源都进行连接呢？这里，我们需要进行甄别，确认操作的真正目标对象。在这两个目标中，添加 和 查询 操作的对象是目录，而 自行车 是输入（参数）或者输出（返回值）。

识别参数和返回值

每个操作可能需要一些额外的参数，API 才能完成内部的处理工作。在 API 的内部过程完成后，也会返回一些对消费者有用的信息（返回值）。参数和返回值就分别对应我们 API 目标表格中的输入和输出。

识别参数和返回值

成果

我们把操作，参数和返回值整合到一起。

操作，参数和返回值

小结

API 目标中的关键动词，一般是对资源进行的操作。API 目标表格中的输入和输出列中的内容，分别对应 REST API 的参数和返回值。下一篇文章中，我们将研究如何表示资源的位置。