确定 API 是 RPC 还是 REST

Question

我最近使用flask 为示例项目设计了一个REST API。前端基于 React.JS。但是我从一位同事那里得到反馈，API 不是 REST API 和它的 RPC。

API 基本上接受 3 个参数、2 个数字和一个操作（'​​add'、'sub'、'mul'、'div'）。在终点http://127.0.0.1:5000/calculator 输入 JSON 将如下所示：

{"value1":"7.1","value2":"8","operator":"mul"}

from flask import Flask, jsonify, request, abort
from flask_cors import CORS

APP = Flask(__name__, static_url_path='')
CORS(APP)  # For cross origin resource sharing
APP.config['CORS_HEADERS'] = 'Content-Type'

@APP.route('/calculator', methods=['POST'])
def calculator_operation():

    if not request.json:
        abort(400)
    try:
        val1 = float(request.json['value1'])
        val2 = float(request.json['value2'])
        operator = request.json['operator']
        if operator == 'add':
            result = val1 + vla2
        elif operator == 'mul':
            result = val1 * val2
        elif operator == 'sub':
            result = val1 - val2
        elif operator == 'div' and val2 == 0:
            result = 'Cant divide by 0'
        elif operator == 'div':
            result = round((val1 / val2), 2)

        return (jsonify({'result': result}), 200)
    except KeyError:

        abort(400)

if __name__ == '__main__':
    APP.run(debug=True)

代码运行良好。我想知道这是基于端点和正在执行的操作的 REST 还是 RPC。

编辑：

Ajax 调用

$.ajax({
            type: "POST",
            url: "http://127.0.0.1:5000/calculator",
            data: JSON.stringify({
                value1: arg1,
                value2: arg2,
                operator: this.state.operation
            }),
            contentType: "application/json",
            dataType: "json",
            success:( data ) => {
                this.setState({ result: data.result, argumentStr: data.result });
            },
            error: (err) => {
                console.log(err);
            }
        });

Answer 1

我想知道这是基于端点和正在执行的操作的 REST 还是 RPC。

客户端如何发现端点是什么，以及输入的 json 是什么样的？

在网络上，会有一种描述表单的标准媒体类型；表单的表示将包括键和值、目标 URI 和要使用的 HTTP 方法。处理规则将描述如何获取表单的详细信息，以及消费者提供的值，并从中构造 HTTP 请求。

这就是 REST：做我们在网络上所做的事情。

另一种 REST 方法是定义 link relation，可能是“http://example.org/calculator”和媒体类型 application/prs.calculator+json，然后在您的上下文中记录“http://example .org/calculator" 链接关系表示目标 URI 响应带有负载 application/prs.calculator+json 的 POST 消息。这基本上就是Atom Syndication 和Atom Pub。

这也是 REST。

菲尔丁对an API he had designed发表了有趣的评论

我还应该注意，上述内容还不是完全 RESTful，至少我是如何使用这个术语的。我所做的只是描述了服务接口，它只不过是任何 RPC。为了使它成为 RESTful，我需要添加超文本来介绍和定义服务，描述如何使用表单和/或链接模板执行映射，并提供代码以有用的方式组合可视化。

也就是说，如果您正在执行 GET-with-a-payload，即语义上带有主体的 safe 请求，那么您可能会陷入 RPC 思维。请注意，在 Web 上，参数化读取是通过向客户端传达如何修改目标 uri 来完成的（例如，通过附加查询字符串以及根据标准化处理规则编码的数据）。

Answer 2

REST 代表 REpresentational State Transfer。您的操作是无状态的，因此没有要转移的状态。但是，您的操作确实接受参数并以过程或函数的方式返回结果，并且它是远程的，因此远程过程调用将是对正在发生的事情的一个很好的描述。毕竟，您为客户提供了一种与语言无关的方式来调用您的calculator_operation 过程。

您的模型中明显缺少的是服务器端数据。通常，REST API 提供了一种与服务器端对象交互的方法：查询、创建、替换、更新或删除。您的服务器端没有保存任何数据：它只是一个回答问题的预言机。你有“查询”方面，没有别的。