Как лучше всего объединить методы GET и POST в api промежуточного программного обеспечения?
Мне нужно создать промежуточный API-интерфейс, который позволяет проверять наличие ключа в моей базе данных. Если ключ существует, его нужно просто получить (метод GET). Если нет, то API должен создать ключ и его значение в базе данных и вернуть их (метод POST). Итак, поскольку в этом API объединены 2 принципиально разных метода, правильно ли это? Каким должен быть лучший способ разработать такой API?
Ответы 3
Не совмещайте их.
Верните нулевой результат из вашего метода GET, если ваша запись не существует. Затем в клиенте, если вы получаете нулевые результаты, POST необходимую информацию для другой конечной точки API.
Объединение двух идей в одну создаст сложную для понимания систему. Ваша система должна быть детерминированной, то есть вы всегда можете знать результат каждого вызова, прежде чем его вызовете.
Один из способов взглянуть на ваш API - это забыть о базовой базе данных, но подумать о том, как клиент API использует ее.
Если клиент API выполняет запрос GET, происходят 2 вещи:
- Возвращается существующая запись
- Новая запись создается и возвращается
На самом деле клиенту может быть все равно, случится ли 1 или 2. С точки зрения клиента может показаться, что ресурс существовал всегда (даже если технически он был только что создан).
Таким образом, пока нет дополнительной информации, которая должна быть отправлена вместе с запросом POST, может быть нормально использовать запрос GET для обоих случаев.
Я не знаю о вашей ситуации, как правило, лучше всего разделить получение и публикацию. Однако, если ваш клиент думает, что ему нужно создать запись, а затем публикует данные, я не вижу проблемы с возвратом ресурса и 409 для уже существующего ресурса. Вот аналогичный вопрос Код ответа HTTP для POST, когда ресурс уже существует
Затем клиент может обрабатывать 409 иначе или так же, как 200, в зависимости от ваших потребностей.