как структурировать XML-ответ REST API

Question

Я пытаюсь определить, как вернуть содержимое XML из моего веб-API.

Должен ли корневой элемент ответа веб-сервера всегда называться «Содержимое», или я должен определить (возможно) другоекорневой элемент для каждого ответа API-вызовов?Или мне вообще нужен корневой ключ?

Answer 1

Этот тип вопроса демонстрирует одну из многих причин, по которым JSON намного превосходит XML для данных . Вам не нужно называть все .

Рекомендация: просто используйте JSON.

Answer 2

Я бы держался подальше от попыток определить это по своему усмотрению и использовать что-то стандартное, например, обтекание в Atom или подобное. Как я упоминал в другом ответе , для этого типа вещей существует прецедент (независимо от того, используете ли вы JSON или XML).

Answer 3

API, который мы поддерживаем, имеет единственный постоянный корневой элемент.На самом деле это зависит от вас.Другими альтернативами могут быть разные корни для возвращаемого типа данных, разные корни для классов или, как вы говорите, разные корни для функции.

Наш API структурирован примерно так (не то, чтобы он был стандартом или чем-то еще):

<product name common root>
<class name>
<function return data>...</function return data>
</class name>
</product name common root>

Мы также разрешаем пакетный вызов, так что это помогает определить, какие результаты какие.

<product name common root>
<class name>
<function1 return data>...</function1 return data>
</class name>
<class2 name>
<function2 return data>...</function2 return data>
</class2 name>
</product name common root>