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

您如何记录由供应商(而不是客户)发起的API例程?,api,rest,Api,Rest,我们正在开发一个RESTAPI,除了开发人员可以访问的各种资源之外,我们的应用程序还将信息发送到客户端服务器上的侦听器脚本 我们的API文档列出了客户端应用程序可以访问的所有“资源”。那部分很简单 但是,我们应该如何列出应用程序将在其中向客户端侦听器脚本发布内容的各种%???%呢 作为开发人员,您希望如何命名这些%???% 谢谢 注1:我使用了%???%,因为我不知道该怎么称呼它们。 注2:我第一次发布到stackoverflow,所以如果我没有遵守协议,请道歉 编辑 很抱歉,不够清晰 我们的A

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

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

但是,我们应该如何列出应用程序将在其中向客户端侦听器脚本发布内容的各种%???%呢

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

谢谢

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

编辑

很抱歉,不够清晰

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

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

或者,以Twitter为例(假设我们是Twitter),当在tweet中提到您时,我们会将该tweet的详细信息发送到您的服务器

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

但是,当我们的API向客户机发送请求时,我们怎么称呼它呢?e、 g.源自API的方法?

参数


我不在乎它们是如何命名的,只要有一些惯例

只需记录下你要发送的内容以及客户应该倾听的内容。我不能告诉你我希望他们的名字是什么,因为你没有说你在做什么。如果有一个
POST
可能有一个表单。注释
%???%
看起来有点像PHP;你用的就是这个吗?然后可能会添加[php]标记。为了提高清晰度,我已经更新了原始帖子。@Cfreak-你几乎理解了我的问题。当然,我们正在记录参数等。我的问题更多的是关于组织文件。规范的一部分称为“资源”(即客户机在我们的API上访问的内容),另一部分(处理我们发送给客户机服务器的内容)称为[填空],这是您考虑过的。看一看,它和你正在做的很相似。