WOLFRAM

Wolfram 语言与系统参考资料中心

How to| 创建即时 API

即时 API 让你可以从网页 URL 中在 Wolfram Cloud 中调用 Wolfram 语言代码. 可使用 Wolfram 语言函数 APIFunction 和 CloudDeploy 来创建一个即时 API 并将其部署至网页. 即时 API 可为私用（那么只有您能使用）或为公用（那么任何人都能使用）. 注意：运行即时 API 会从您的账户中使用 Wolfram Cloud Credits.

以下操作设置一个可以找到某积分的平方的 API，并将其部署至云端：

Wolfram Language code: CloudDeploy[APIFunction[{"x" -> "Integer"}, #x ^ 2&]]

这里说明您如何能从网页浏览器上运行该 API：

    

一个 API 要求以下三个要素：指定参数和其类型、指定该 API 应该运行的代码、指定该 API 的结果该如何返回.

Wolfram 语言支持多种类型的参数，以下列出.

这样可以创建一个 API（其参数名称为 "name" 的参数，代表一个国家），并返回一个 PNG：

Wolfram Language code: CloudDeploy[APIFunction[{"name" -> "Country"}, GeoGraphics[#name]&, "PNG"]]

在浏览器上调用该 API 会给出如下结果：

    

可以指定 API 的代码使其运行纯函数，函数参数名称为 #name，参数结尾有一个 &，表示这是一个纯函数.

以下操作可部署一个即时 API，其参数 x 和 y 为数字，其代码为将这些数字相加：

Wolfram Language code: CloudDeploy[APIFunction[{"x" -> "Number", "y" -> "Number"}, #x + #y&]]
    

也可以指定 API 部署的权限；以下操作可使该 API 变为公有：

Wolfram Language code: CloudDeploy[APIFunction[{"name" -> "Country"}, GeoGraphics[#name]&, "PNG"], Permissions -> "Public"]
    

若在浏览器中调用 API 但没有参数，则会出现如下表格：

    

调试 API 的一个方法是让其完全在 Wolfram 语言中运行. APIFunction 运行时就像是一个用关联作为参数的纯函数：

Wolfram Language code: APIFunction[{"x" -> "Number", "y" -> "Number"}, #x + #y &][<|"x" -> "7", "y" -> "88"|>]