REST представление для xml - PullRequest
Новая
       11

REST представление для xml

0 голосов
/ 03 декабря 2010

Я создаю REST API и обсуждаю, какой формат мне использовать для представления XML. Я знаю, что это может быть определено в доме, но есть также много форматов. wadl выглядит интересно, но, кажется, спорят об этом, и это тоже ново.

каковы рекомендации (лучшие практики для этого)?

1 Ответ

0 голосов
/ 03 декабря 2010

Пока это действительный XML, это начало.Моя общая стратегия для простых служб REST / XML заключается в следующем:

Для синтаксического анализа вам почти наверняка нужен один всегда присутствующий корневой узел, например, «ответ», который может содержать либо элемент результата, либо элемент ошибки.,Например: 

<response>
  <result>
    <answer>5</answer>
  </result>
</response>

То, как вы структурируете результаты, зависит от вас.Вы можете решить, следует ли хранить данные в элементах в виде CDATA (текстовые примечания, как показано выше) или в качестве обязательных атрибутов, например 

<answer value="5"/>

. Другая полезная вещь заключается в том, чтобы включить в ответ ваш исходный запрос,Например: 

<response query="operation=add&a=2&b=3"> .. </response>

Таким образом, если у вас есть несколько невыполненных запросов, вы можете сопоставить их с исходным запросом.

...