Проверить RoR json API - PullRequest
       3

Проверить RoR json API

0 голосов
/ 03 февраля 2020

Любой способ (я имею в виду код RoR) перечислять

  • существующие конечные точки API
  • входные данные с типами данных
  • выход данные с типами данных
  • что-то еще

Предположим, мы используем ruby на рельсах, и наш API основан на моделях и их типах.

(что-то вроде схемы здесь )

Что возможно и как? Что не возможно и почему?

1 Ответ

2 голосов
/ 03 февраля 2020

Обычно это невозможно.

Контроллеры (и модели) в приложении Rails определяют на разных уровнях, какие данные принимать. Обычно это определяется не в формате stati c, а через многоуровневый процесс проверки (например, на контроллере с strong_parameters и моделях с их проверками.

, поскольку эти проверки могут определять произвольно сложные бизнес-правила, использующие код Ruby, обычно, таким образом, вы можете только проверить, принята ли данная структура данных, пытаясь передать ее приложению и проверить, принимает ли она это без ошибок.

При этом Тем не менее, существуют гемы, которые позволяют вам определять «абстрактные» схемы API, которые могут использоваться внешними клиентами и использоваться для проверки данных в вашем приложении. Примерами здесь являются trailblazer , dry -validation , json -schema и др. Обратите внимание, что эти подходы обычно требуют соблюдения архитектурных требований этих драгоценных камней, которые могут сильно повлиять на способ разработки приложения.

...