Рекомендации по использованию REST API, которые обращаются к нескольким средам

Question

При написании API RESTful, который должен иметь доступ к различным средам, таким как лабораторная/тестовая база данных и производственная база данных, каковы наилучшие методы создания API?

Должен ли быть @PathParam:

/employee/{emp_id}/{environment} 
/{environment}/employee/{emp_id}/ 

Должен ли быть @QueryParam:

/employee/{emp_id}/?environment="test" 
/employee/{emp_id}/?environment="prod" 

Должен ли быть поле в полезной нагрузке ?:

{"emp_id":"123","environment":"test"} 
{"emp_id":"123","environment":"production"} 

Answer 1

В Я вижу два способа справиться с этим. Причина использования того или другого соответствует тому, что наиболее удобно реализовать в вашем приложении RESTful.

• Использование параметра пути

  При таком подходе он должен быть параметром путь в самом начале пути ресурсов. Таким образом, URL-адрес будет выглядеть так: /{environment}/employee/{emp_id}. Такой подход удобен, если несколько приложений развернуты под разными корневыми путями. Например:

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

  В этом случае, приложения для каждой среды изолированы.

• Использование пользовательского заголовка

  Вы можете также пользовательский заголовок указать на какую среду маршруту. Github использует что-то подобное, чтобы выбрать версию API для использования. См. Эту ссылку: https://developer.github.com/v3/#current-version. Это не совсем то же самое, но вы могли бы иметь что-то вроде этого:

  GET /employee/{emp_id} 
  x-env: test 
  

  обратного прокси может обработать этот заголовок и маршрут запроса в правой среде.

Я не уверен в подходе в полезной нагрузке, так как поле environment действительности не является частью представления для элемента ресурса employee. Что касается подхода параметра запроса, это похоже на то, что такие параметры применимы к запросу на ресурсе.

Надеется, что это помогает вам,