Fusio Api 之Operation

fusio6个月前更新 admin
266 0

一个操作对应于一个HTTP方法和路径,并调用一个特定的Action。你可以为这个操作附加各种元信息,比如参数、输入和输出模式的Schema或描述。Fusio Api 可以使用这些信息来生成合适的OpenAPI规范或客户端SDK。如果请求方法是公开的,则可以在没有访问令牌的情况下请求API。

Fusio Api 之Operation

Scopes:以逗号分隔的值,即访问权限。如果操作受到保护,终端用户需要获得相应的权限范围才能访问该端点。

Active:操作是否处于活动状态。如果操作未处于活动状态,则无法调用此操作。

Public:是公开操作还是私有操作。如果操作是私有的(默认情况下),用户需要提供一个(token)访问令牌来调用该操作,同时用户还需要具有相应的权限范围才能调用此操作。

Stability:标识操作的状态。

  • Deprecated:已弃用
  • Experimental:实验型
  • Stable:稳定【如果Stability的值是Stable,则无法自身以外的其他值。】
  • Legacy:旧版

Description:对此操作的简短描述。

HTTP Method:HTTP 请求方法定义了客户端和服务器之间的通信方式。以下是Fusio支持的 HTTP 请求方法列表:

  • GET
    从服务器获取资源。用于请求数据而不对数据进行更改。
  • POST
    向服务器发送数据以创建新资源。常用于提交表单数据或上传文件。发送的数据包含在请求体中。
  • PUT
    向服务器发送数据以更新现有资源。如果资源不存在,则创建新的资源。与 POST 不同,PUT 通常是幂等的,即多次执行相同的 PUT 请求不会产生不同的结果。
  • PATCH
    对资源进行部分修改。与 PUT 类似,但 PATCH 只更改部分数据而不是替换整个资源。
  • DELETE
    从服务器删除指定的资源。请求中包含要删除的资源标识符。
  • ps:以上http请求方法介绍截取自菜鸟教程。

HTTP Path: HTTP 路径可以包含带变量的路径。在 action 中访问这些变量。以下列表描述了语法。

  • /product 不带变量的路径,只有请求匹配此路由/product
  • /product/:product_id带变量的简单路径。此路由匹配除斜杠之外的任何值。即匹配此路由/product/foo或/product/12,变量为foo或12。
  • /product/$year<[0-9]+>具有正则表达式的变量路径。即仅匹配此路由/product/2015
  • /file/*path匹配所有值的变量路径。即匹配此路由/file/foo/bar或/file/12

HTTP Code:这大多是 OK 或 Created

Parameters:定义此操作的所有查询参数。【目前没发现用途】

Incoming和Outgoing:默认选【Schema】选完后点击后面的输入框(输入名称以选择合适的请求和响应数据格式)。

  • Schema
    选择之前在Schema操作面板上创建的Schema
  • Class
    引用 源代码中提供的 PHP 类,即 .您也可以自动 生成这些模型类
  • HTTP/HTTPS
    调用 HTTP URL 并解析 schema。
  • File
    Loads:加载文件解析架构schema。

Throws:【默认为空即可】用于描述错误响应负载的架构。您可以选择以下架构源之一:

  • 感觉官方文档出错了

Action:该操作包含 API 节点的业务逻辑。它即从数据库中选择或插入条目,或者将新条目推送到消息队列。您可以选择不同类型的操作,以下列表描述了每种操作 类型:

  • Action
    选择之前在Action操作面板上创建的Action
  • Class
    引用:源代码中提供的 PHP 类,即 Action 类的实现。
  • HTTP/HTTPS
    调用 HTTP URL,它将请求代理到Api节点,并添加 Fusio 特定信息。
  • File
    文件,官方没有解释,测试后在修改。

Costs:用户需要支付多少费用才能调用此操作。

© 版权声明

相关文章