Правила проверки запросов REST для модели - PullRequest
0 голосов
/ 01 октября 2019

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

Вот вымышленный пример:

{
  "name": "string",   // 1 to 50 characters.
  "gender": "string", // Must be one of 'Male', 'Female', 'Legal Entity'
  "BirthYear": "int"  // [1900, 2019] - Default 1999
  "weight": "decimal" // numeric(10, 2) Precision=10, Scale=2
  "deceased": "bool"  // Default = false.
}

Я знаю, что могу использовать EnumDataType для перечисления перечисленийв Swagger, но иногда у меня есть динамические перечисления на основе значений в базе данных. Например, гендер может быть динамичным, так как люди все время отождествляют себя с новыми полами:)

Итак, в REST есть известная схема передачи такой информации клиенту из API, например, через глагол OPTION?

Кто-нибудь может указать на хорошую статью или информацию о чем-то подобном?

1 Ответ

0 голосов
/ 02 октября 2019

Я думаю, вы должны проверить тип, и если поле не пустое, если жанр не существует в базе данных, вы бросаете код состояния 422, который указывает на семантическую ошибку (клиент хочет POST / UPDATE с правильным носителемтип, правильный синтаксис, но неверное семантическое значение).

Необязательный метод в соответствии с RFC2616 используется для просмотра поддержки какого ресурса или сервера (например, разрешенных методов и заголовков):

Метод HTTP OPTIONS используется для описания параметров связи для целевого ресурса.

...