API 调用的默认语法是啥？

Posted 2023-03-31

【中文标题】API 调用的默认语法是啥？

【英文标题】：what is the default syntax of an API call?API 调用的默认语法是什么？

【发布时间】：2014-08-18 19:23:27

【问题描述】：

有人可以帮助我了解以下 API 的特定 API 链接示例是什么样的吗？

https://engradesandbox.com/docs/

他们在文档中展示了有关 API 的 JSON 结果/返回的示例，但没有显示调用的实际示例。

我在大多数 API 中都注意到了这一点，它们显示了可能的结果数据，而不是默认的 url 语法。这太令人沮丧了，因为浏览现有的宁静教程在这个主题上也不是很有成果。 你怎么知道实际的 API 调用应该是什么样子？

【问题讨论】：

API 没有“默认语法”。 API 没有标准。

【参考方案1】：

这确实告诉你该怎么做。

所有“调用”都将通过 HTTP POST 发送到指定的 URL。 如果您单击其中一个，它会将您带到解释该方法的输入数据的页面。

例如，请参阅class-behavior-add 函数。要调用该函数，您需要发布到他们指定的 URL（截至本文发布时为 https://api.engradesandbox.com/），并且您的帖子内容将是 XML 或 JSON，其中包含指定的字段 here。

以 JSON 格式发布数据示例：

    "apitask": "class-behavior-add",
    "apikey": "your_api_key",
    "ses": "session token id",
    "clid": 1234567890,
    "stuid": "student ID",
    "date": 123456789,
    "mark": 12,
    "points": 123

以 XML 格式发布数据示例：

<engrade>
    <apitask>class-behavior-add</apitask>
    <apikey>your_api_key</apikey>
    <ses>session token id</ses>
    <clid>1234567890</clid>
    <stuid>student ID</stuid>
    <date>123456789</date>
    <mark>12</mark>
    <points>123</points>
</engrade>