Что делать с неподдерживаемыми параметрами в API? - PullRequest
0 голосов
/ 20 сентября 2019

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

Мы создаем API, который будет извлекать медицинскую карту пациента.Клиент может запросить все о пациенте: запись пациента / идентификатор

Или он может запросить определенный раздел записи пациента: запись пациента // идентификатор / аллергия запись пациента / идентификатор / клинические признаки запись пациента / идентификатор / сводка

Только 7 из этих разделов поддерживают дату.3 раздела нет.Итак, я хочу знать

  1. Какой запрос HTPP мы должны вернуть для пациентаrecord / id /? StartDate = 2018-01-01

В этомНапример, они запросили всю историю болезни пациента.Мы вернем 10 разделов, но только 7 будут отфильтрованы по дате.Какой HTTP-статус подходит / как мы можем сообщить им, что мы применили фильтр даты только к 7 разделам?

Какой HTTP-запрос мы должны вернуть: Patient Record / ID / Summary? StartDate = 2018-01-01

Предполагается, что это раздел, который не поддерживаетфильтрация даты.Мы возвращаем 200 и игнорируем фильтр даты?Или верните 400/422 и скажите, что фильтрация даты не поддерживается в этом конкретном разделе?

Какой HTTP-запрос мы должны вернуть: Patient Record / ID /? Blah = true

Где Blah - это параметр, который мы вообще не поддерживаем ни для одного раздела,Вернем ли мы 200 и полностью проигнорируем параметр?Потому что это не допустимый параметр в любой ситуации?

...