您如何记录供应商(而非客户)发起的API例程?

时间:2012-08-07 03:12:38

标签: api rest

我们正在开发REST API,除了开发人员可以访问的各种资源之外,我们的应用程序还会将信息发送到客户端服务器上的侦听器脚本。

我们的API文档列出了客户端应用程序可以访问的所有“资源”。那部分很容易。

但是我们应该如何列出我们的应用程序将内容POST到客户端监听器脚本的各种%???%?

作为开发人员,您如何期望这些%???%被命名?

由于

注1:我使用了%???%,因为我不知道该怎么称呼它们。 注2:我第一次发布到stackoverflow,如果我没有遵循协议,那么道歉。

修改

抱歉缺乏清晰度。

我们的API接收来自客户的请求。它还向客户发送请求。

例如,当客户端收到消息时,我们会将该消息发送到他们的服务器。或者,当他们之前发送的其中一条消息的状态已更新时,我们会将更新发送到他们的服务器。

或者,以Twitter为例(想象我们是Twitter),当你在推文中提到时,我们将这条推文的详细信息发送到你的服务器

当客户端向我们的API发送请求时,该请求被描述为“访问资源”,文档列出“资源”。

但是当我们的API向客户端发送请求时,我们称之为什么?例如API发起的方法?

1 个答案:

答案 0 :(得分:2)

参数?

只要有一些惯例,我就不在乎它们的名称!