数据操作的API命名约定

我正在构建一个gRPC服务,该服务负责创建和删除网络事件数据。 该API应该获得网络事件列表作为输入,进行一些处理,然后将结果以JSON格式保存在Elasticsearch中,
一个输入示例:

{"source" : "1.2.3.4","destination" : "3.4.5.6","numberOfPackets" : 12345,"Protocol" : "TCP"}.

普通的动词+名词API命名约定(CreateNetworkEvent)在这种情况下感觉有些不对劲,因为我也没有“创建”任何事物的实例。它没有ID,因此无法直接检索。稍后将在过滤器,聚集等中使用。

这种动作是否有命名约定?

yousb002 回答:数据操作的API命名约定

对于GRPC和REST都支持的API,GCP拥有some recommendations。那些人会建议使用名称CreateNetworkEvent,尽管它也会建议对此RPC的响应返回调用GetNetworkEvent方法所需的数据。

从语义上讲,RPC不如REST严格。如果您的API没有面向资源的语义,那么您应该可以使用任何喜欢的动词-名词组合。也许RecordEvent

本文链接:https://www.f2er.com/2765688.html

大家都在问