Я моделирую REST API, как показано ниже.
GET API / метаданные
API должен возвращать список метаданных, а также URL-адрес веб-приложения.Вызывающая сторона API будет искать этот URL, а затем использовать этот URL для вызова веб-приложения.Перед выполнением этого HTTP-вызова он также должен предоставить значения для параметров запроса.
Вот пример ответа
{
"item1" : "value 1"
"item2" : "value 2"
"url" " "http://myserver.com/page?id=10&mode=advanced"
}
Параметр запроса "mode" может иметь 2 значения, "расширенный""или" по умолчанию ".«advanced» отобразит пользовательский интерфейс с расширенными элементами управления, а «default» - пользовательский интерфейс с простыми элементами управления.
В приведенном выше примере в качестве значения по умолчанию используется значение «advanced».Я не хочу иметь никакого значения по умолчанию, так как я хочу, чтобы вызывающая сторона явно предоставляла значение для параметра запроса «mode».Если это так, то как должно выглядеть значение URL в ответе API.
Вот параметры
- http://myserver.com/page?id=10&mode=
- http://myserver.com/page?id=10&mode=$modevalue$
Во 2-м случае вызывающая сторона должна заменить $ modevalue $ на «advanced» или «default»
Пожалуйста, дайте мне знать, как лучше всего представить URLв ответе API?Или есть другой способ?