Соглашения об именах API для действий с данными

Question

Я создаю службу gRP C, которая отвечает за создание и удаление данных о сетевых событиях. API должен получить в качестве входных данных список сетевых событий, выполнить некоторую обработку и сохранить результаты в Elasticsearch как JSON,
пример ввода:

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

Нормальный глагол + существительное именование API соглашений (CreateNetworkEvent) чувствует себя немного не по этому сценарию, так как я ни "создать" экземпляр чего-либо. У него нет идентификатора, и его нельзя получить напрямую. Он будет использоваться позже в фильтрах, агрегации и т. Д. c.

Существует ли соглашение об именах для этого типа действия?

Answer 1

GCP имеет некоторые рекомендации для API, которые представлены как gRP C, так и REST. Они рекомендуют имя CreateNetworkEvent, хотя также рекомендует, чтобы ответ на этот RP C возвращал данные, необходимые для вызова метода GetNetworkEvent.

RP C Семантически менее строг, чем REST. Если ваш API не имеет ресурсно-ориентированной семантики, тогда вы сможете использовать любую комбинацию глагола и существительного, какую пожелаете. Возможно RecordEvent?