插件调用OpenAPI

适用环境	SaaS
	私有部署

要求

ONES
v3.14.138+,v6.2.4+

概述

本文描述了一种在插件中访问 ONES OpenAPI 的方法。该方法通过 @ones-op/fetch 包定义的 FetchAsUser 和 FetchAsAdmin 方法，实现自动完成 OAuth2 授权并获得 Token 及 Token 失效后自动进行重新获取的功能。

使用

第一步：安装依赖

进入插件工程的/web 或 /backend 目录，执行以下命令进行依赖安装：

npm i @ones-op/fetch

第二步：配置插件的授权信息

配置文件： config/plugin.yaml

格式示例：

config/plugin.yaml

oauth: # 定义插件授权配置
  type: # 插件授权身份类型
    - user
    - admin
  scope: # 插件授权范围
    - read:project:project
    - write:project:project

以普通用户身份访问：

config/plugin.yaml

oauth:
  type:
    - user

以组织管理员身份访问：

config/plugin.yaml

oauth:
  type:
    - admin

信息

1. 通常建议前端插件使用 user 类型，后端插件使用 admin 类型访问 OpenAPI。
2. admin 类型访问无法在前端使用。
3. 插件允许访问的 OpenAPI 范围是通过 scope 参数定义的，更多参数值请参考：OAuth 应用程序的范围。

第三步：访问 OpenAPI

API： FetchAsUser / FetchAsAdmin

具体用法请参考：@ones-op/fetch。 插件安装并启用（授权）后，该插件即可访问 ONES OpenAPI。