API功能  

参数类型列表»

API功能[{"名称1"类型1,"名称2"类型2,…},乐趣]

表示带有参数的API名称我对函数求值的乐趣每当它被调用时。功能乐趣应用于"名称1"val值1,"名称2"val值2,…，其中val值我是参数的设置，解释为类型类型我.

API功能[{"名称1"类型1违约1,…},乐趣]

采用参数的值名称我成为违约我如果调用API时未指定。

API功能[参数,乐趣,柔性制造技术]

指定应用的结果乐趣应以格式返回柔性制造技术.

API功能[参数,乐趣,{柔性制造技术,r形式}]

指定结果应作为表单的响应返回r形式.

API功能[参数,乐趣,{柔性制造技术,r形式,故障（failfmt）}]

指定在出现故障时，应以格式返回结果故障（failfmt）.

详细信息和选项

  • 云部署[API功能[…]]部署API函数，以便可以使用web GET请求（如从web浏览器或POST请求）在云中对其进行外部调用。
  • API功能采用参数设置名称我=字符串我在web查询字符串或POST请求中，并将其转换为元素"名称我“->口译员[类型我]["字符串我"]在其关联中乐趣已应用。
  • 在Wolfram语言中，API功能[…][协会会员]可用于重现使用中给定的参数设置调用API函数的效果协会会员。在这种情况下，如果任何设置不是字符串，则直接使用它们的值，而不进行类型解释。
  • 可能的形式类型我规格如下：
  • "形式"支持的任何形式口译员
    受限制的[…],等。支持的任何限制形式等口译员
    口译员[…]任何口译员对象
    协会会员给出如何处理参数的详细信息的关联
    t风机要应用于字符串的任何函数
  • 关联中可能的元素包括：
  • “口译员”用于此参数的解释程序
    “必需”是否需要此参数
    “默认”默认值,如果有,对于参数
    “允许的扩展”扩展以允许此参数
    “帮助”帮助关联参数
  • 的默认值“允许的扩展”是继承，对应于设置中指定的允许扩展API功能选项允许的云参数扩展.
  • 当在云端呼叫时，API功能[参数,乐趣]默认情况下，返回结果的文本Wolfram语言形式。
  • 可能的结果格式柔性制造技术在里面API功能[参数,乐趣,柔性制造技术]是：
  • "柔性制造技术"支持的任何格式导出表单
    （f）要应用于的任意函数身体
  • API功能[参数,乐趣,"柔性制造技术"]等于API功能[参数,导出表单[乐趣[#],"柔性制造技术"]&]部署时。请注意导出表单评估时不会显示API功能在笔记本上。
  • 典型的可能结果格式包括：
  • 无纯Wolfram语言文本(违约)
    “GIF”,“JPEG”,“巴布亚新几内亚”,…结果的图像
    “字符串”作为原始字符串的字符串结果
    “HTML”结果的纯静态HTML版本
    “HTML主题”带有内置主题的静态HTML
    “HTML面板”面板中的HTML内容
  • API功能支持以下选项：
  • AllowedCloudExtra参数 无允许API使用哪些额外参数
    允许的云参数扩展 自动允许参数使用哪些扩展
    图像格式宽度自动输出格式的环绕宽度
    图像大小自动输出的整体图像大小
  • API功能[参数,乐趣,{"柔性制造技术","r形式"}]等于API功能[参数,回复表单[导出表单[乐趣[#],"柔性制造技术"],"r形式"]&]部署时。请注意，两者都不是回复表单也不是导出表单将在评估时显示API功能在笔记本上。
  • 如果参数解释不成功，乐趣不应用，而返回的结果为失败["型钢混凝土",<|文件名1->失败[…],文件名2->失败[…]|>]，其中文件名我解释失败的参数的名称。
  • 如果缺少没有默认值的参数，失败[“MissingParameter”,…]生成。
  • 如果rform格式指定，则失败[…]表达式直接传递到响应表单，无论是否柔性制造技术已指定。
  • 当API由定义时API功能[…]通过web调用，如果成功解释参数，则返回HTTP状态代码200，并且应用的结果乐趣不是失败[…]。否则返回状态代码400。
  • 在API功能[参数,…]，的参数可以是窗体对象或中用作表单规范的其他表单窗体函数。忽略与API无关的表单规范的功能。API功能允许与相同的选项窗体函数但忽略那些不适用的。
  • 在API功能[…,柔性制造技术]或在中API功能[…{柔性制造技术1,…}]，任何柔性制造技术表达式可以作为字符串格式或表单列表给出{"柔性制造技术",optname（操作名）1opt值1,…}，其中选择名称我是的选项"柔性制造技术"格式。

示例

全部打开全部关闭

基本示例  （4）

具有一个名为的参数的API函数x个应用于协会以下为：

带有可选参数的API函数具有默认值：

使用云部署要将API功能部署到Wolfram Cloud：

可以通过在web浏览器中访问云对象并附加?x个=价值到其URL：

呼叫API功能如果输入数据不足，将返回失败以下为：

范围  (6)

一个API函数，在包含计算元信息的JSON容器内以Wolfram语言文本形式返回计算结果：

口译员规范  (1)

使用rich口译员规格：

列表可用于创建选项列表：

默认值  （4）

指定字段的默认值；具有默认值的字段不是必需的：

字段可以是可选的，没有默认值：

使用默认规范允许空字符串：

使用规则延迟每次评估新的默认值：

选项  (3)

允许的云额外参数  (1)

允许调用API功能设置用于导出结果的格式：

如果“导出表单（_E）”调用中未指定参数API功能不会导出结果：

允许的云参数扩展  (2)

部署API功能接受的JSON格式编码矩阵：

部署API功能接受作为Wolfram语言数据提供的参数：

应用  (7)

获取任何国家的地图：

查找给定符号的最新股价：

绘制a细胞自动机以下为：

部署棒形图应用程序编程接口：

部署API以创建并重定向到新的窗体函数以下为：

部署API以获取给定年份任何国家的人口：

从模板返回完整网页：

属性和关系  (9)

可以从任何HTTP客户端访问部署的API（如果需要，可以提供适当的身份验证）：

API功能设计为可与窗体函数以下为：

反之亦然：

API功能接受与相同的选项窗体函数但忽略了其中大多数：

的单个字段API功能使用口译员转换Wolfram语言表达式中的输入：

这实际上与以下内容相同：

与申请相同口译员直接：

安API功能使用执行$评估环境设置为“WebAPI”和$云评估存在真的以下为：

将此结果与桌面会话中的结果进行比较：

评估环境云评估（CloudEvaluate）是“网站评估”以下为：

API功能用于根据输入参数按需进行计算。对于不依赖于任何输入参数的计算，延迟也可以使用：

使用的等效代码API功能以下为：

的结果$云评估是真的执行API函数和使用云评估（CloudEvaluate）以下为：

使用默认设置包含定义真的，部署API函数包括它所依赖的所有定义：

可能出现的问题  (3)

只有在web上执行API时，才会应用导出和响应格式：

手动生成对API功能，申请很重要URLEnco代码到它：

注意，呼叫URLExecute公司使用规则列表将自动编码查询参数：

多次请求同一个API功能通常不会在同一个Wolfram引擎中进行评估，因此定义不会在请求之间持久存在：

Wolfram Research（2014），APIFunction，Wolfram语言函数，https://reference.wolfram.com/language/ref/APIFunction.html（2017年更新）。

文本

Wolfram Research（2014），APIFunction，Wolfram语言函数，https://reference.wolfram.com/language/ref/APIFunction.html（2017年更新）。

CMS公司

沃尔夫拉姆语言。2014年，“APIFunction”，Wolfram语言与系统文档中心。Wolfram研究。上次修改日期：2017年。https://reference.wolfram.com/language/ref/APIFunction.html。

亚太地区

沃尔夫拉姆语言。(2014). API功能。Wolfram语言与系统文档中心。检索自https://reference.wolfram.com/language/ref/APIFunction.html

BibTeX公司

@misc{reference.wolfram_2024_apifunction，author=“wolfram Research”，title=“{apifunction}”，year=“2017”，howpublished=“\url{https://reference.jolfram.com/language/ref/apifunction.html}”]}

BibLaTeX公司

@online{reference.wolfram_2024_apifunction，organization={wolfram Research}，title={apifunction}，year=2017}，url={https://reference.jolfram.com/language/ref/apifunction.html}，note=[访问时间：2024年6月1日]}