Передача открытых атрибутов / переменных объекта в ответах API - хорошая практика? - PullRequest
0 голосов
/ 10 сентября 2018

Таким образом, один из наших API имеет функцию получения ограниченных необработанных данных, их обогащения, а затем возвращает их запрашивающей стороне.В настоящее время контроллер явно создает объект ответа.Однако, поскольку мы постоянно увеличиваем атрибуты / переменные в ответе, контроллер становится скорее Phat (да с Ph).Один из способов сделать код более СУХИМЫМ - это автоматически пересылать любые открытые (т.е. не частные или защищенные) переменные из различных экземпляров объекта.Чтобы получить больше контекста:

  • Этот API не обрабатывает конфиденциальные данные (пользователи, заказ, платежи)
  • API не является общедоступным (требуется активный зарегистрированный пользователь)
  • Возвращенные данные - это все обогащенные данные, полученные из необработанных, неструктурированных данных запрашивающей стороны.

Если быть более точным: то, что я имею в виду под пересылкой, - это чтобы контроллер перебрал все открытые атрибутыиспользуемые объекты и автоматически включают их в объект ответа

Пока единственные минусы, о которых я могу думать, это:

  • Разработчики, случайно выставившие атрибут / переменную, забыв сделать этоприватный или защищенный
  • Потенциально выставляя некоторые следы чертежей исходного кода (Но, учитывая, что они будут только публичными переменными / атрибутами и ничто иное, этот кажется довольно параноидальным)

Полагаю, яскучаю больше.

1 Ответ

0 голосов
/ 11 сентября 2018

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

...