速成班101
10 模块
5 周数

一般信息

点击复制

端点介绍


最后一个模块以创建第一个业务流程结束。我们弄清楚了如何创建流程逻辑,接受特定的输入参数,进行计算并发出答案。剩下的就是回答主要问题了。如何激活创建的业务流程并将其投入运行?

为了解决这个问题,我们打算使用端点--与应用程序互动的关键点。在第一个模块中,我们已经与外部API进行了交互。由于端点的存在,这是有可能的。文档中对它们进行了描述,我们阅读了文档并理解了发送请求以访问特定资源所需的方法和URL。

为了理解,让我们用一个具体的例子来看一下端点的实现。在第三个模块中,数据库模型被创建。同时,在创建表的同时,自动创建了端点来与它们进行交互。让我们去看看端点部分(在左边的面板上),看看它们。


以包含城市信息的 "city"表为例,可以看到它已经有6个端点用于基本数据操作。

  • GET /city- 从一个表中获取所有数据
  • GET /city/:id- 获取具有指定id的城市的数据
  • POST /city- 在表中添加一个新的记录
  • PUT /city/:id- 完全替换表中具有指定id的记录
  • PATCH /city/:id- 部分替换表中具有指定id的记录
  • DELETE /city/:id- 从表中删除一个有指定ID的记录

一般设置

你可以打开每个端点的设置,更详细地研究它。例如,考虑端点 GET /city/:id


我们看到的图片与我们在创建对外部API的请求时已经看到的情况非常相似。在一种情况下,我们只访问了一个现成的端点,而现在我们要自己创建和配置这个端点。为了配置,你必须指定。

  1. 请求方法。在这个例子中,这就是GET 方法。
  2. 请求URL。第一部分是到服务器的路径,没有指定。它对所有的应用端点都是一样的。只需指定结尾(/city)即可。URL参数也在这里指定。这个端点被设计用来接收某个城市的信息,所以它的id写在": "后面,作为一个参数被传递。
  3. Endpoint Groups.这个参数不会以任何方式影响端点的操作,只是为了方便组织。所有的端点都可以被划分为专题组(文件夹)。在这个例子中,"city"组包含所有用于处理城市数据的端点。
  4. Business Process.这是最重要的配置项,是在向端点发送请求时无法以任何方式看到的东西。业务流程的指示决定了这个端点将做什么。同时,端点本身可以保持不变,它将在旧地址接收所有相同的请求,同时,如果业务流程被替换,它将执行完全不同的功能。基本数据库活动的业务流程是自动创建的。它们被称为系统业务流程。这样的BPs不能被改变,但可以在任何时候用独立创建的BPs,用自定义的业务流程取代。
  5. Input/Output variables.创建的业务流程使用各种输入和输出变量,但终端不一定要使用所有的变量。部分可以被禁用或配置,以便不同的端点访问同一个BP,使用一组单独的变量。请求和响应类型(Request / Response type)也是在那里配置的。大多数情况下,这种类型将是JSON,但是,如果有必要,可以使用其他选项,如XML或Render File (这种类型的响应在端点中用于处理文件)。

中间件设置

一般的设置对于创建和进一步使用端点是足够的,但如果有必要,可以使用附加参数。其中最重要的是用Auth token激活Middleware


它的使用允许你拒绝未经授权或不属于某个组的用户访问这个端点(例如,可以只允许管理员访问而拒绝其他用户访问)。

日志和输出设置

此外,你可以使用Settings 标签上的设置来额外地记录头信息或请求正文,以及从响应中隐藏那些没有设置值的字段。


Was this article helpful?
还在寻找答案吗?
加入社区