跳到主要内容

快速上手

欢迎使用 Matesst 文档。Matesst 结合 Matesst Turbo JIT (Powered by RunMat) 与 GNU Octave 双引擎，让您无需重写代码，即可轻松将 .m 脚本算法扩展为高性能生产级 RESTful API。

按照以下 5 个步骤，即可启动并运行您的第一个 API。

1. 创建应用 (APP)​

首先，登录 Matesst 控制面板。在左侧菜单进入 Dashboard (控制面板)，点击 Create APP。为您的应用起一个唯一的名称。

创建应用

2. 准备并上传源码包​

首先，编写您的自定义算法。代码中的函数名将作为 API 的入口点。例如创建一个名为 my_math.m 的文件：

% 文件: my_math.m
% 这是您算法的入口函数。
% 文件名（不含 .m）将成为 API 的调用端点。

function [sum_val, prod_val] = my_math(a, b)
    % 一个简单的算法示例：计算和与积
    sum_val = a + b;
    prod_val = a * b;
end

将这些文件直接压缩为 ZIP 格式（例如 my_math.zip）。Matesst 完美支持复杂的项目目录结构，您可以在 ZIP 包中自由组织子文件夹。

提示： 为避免函数名称冲突（Shadowing），请确保您的入口函数在整个项目包中具有唯一的名称。

接着，进入 My Apps (我的应用) 页面，选择您的应用并上传该 ZIP 包。Matesst 将自动分析其中的入口函数。

上传源码

3. 管理与授权​

在应用详情页面，您可以监控部署状态。每个应用都拥有独立的 API Key。请妥善保管此 Key，它是调用该应用 API 的唯一凭证。

应用管理

4. 财务与卡密兑换​

Matesst 使用点数系统进行计费。您可以在 Orders (充值订单) 页面查看 当前余额 (Balance)。如果您持有卡密，输入卡号和密码即可兑换 点数 (Credits)。

财务兑换

5. 监控调用日志​

在 Logs (调用记录) 页面可以查看详细的执行历史。系统按运算时间计费，每秒消耗 1 个点数 (1 Credit/s)。这有助于您实时审计成本。

调用日志

您的第一个请求​

应用激活后，您可以通过 POST 请求调用。以下是调用上方 my_math 函数的示例。注意替换为您应用的专属 API Key：

curl -X POST https://api.matesst.com/api/v2/my_math \
  -H "Authorization: Bearer YOUR_APP_SPECIFIC_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "params": [10, 20],
    "nargout": 2
  }'

结果包装规则 (Results Wrapping)​

results 字段的结构取决于 nargout 以及返回的数据类型：

  • 当 nargout = 1 且结果为单个数字时：results 将直接返回该数字。
  • 其他情况：results 始终会被包装在数组中。例如，如果函数返回数组 [1, 2, 3] 且 nargout = 1，则结果将包装为 [[1, 2, 3]]。

示例：单个数字 (nargout = 1)​

{
  "results": 30,
  "status": "success"
}

示例：多个输出 (nargout = 2)​

{
  "results": [30, 200],
  "status": "success"
}

示例：返回值为数组 (nargout = 1)​

{
  "results": [[1, 2, 3]],
  "status": "success"
}

接下来，请查看完整的 API 参考 以了解更多细节。