Welche XML-Struktur eignet sich am besten für eine Allround-API?

Question

Bitte beraten Sie mich, wenn Sie können.

Ich baue eine SMS-Webdienst-API auf, die es Menschen ermöglicht, SMS an ihre gewünschten Handynummern zu senden. Eine Anfrage wird an die Schnittstelle gesendet, die wir dann auf der Grundlage der angegebenen Kontodaten und des auf dem Konto verfügbaren Guthabens verarbeiten.

Wir haben zwei vorgeschlagene XML-Strukturen für die Schnittstellenanforderung, und ich möchte Sie bitten, uns mitzuteilen, welche davon besser ist, da wir uns gegenseitig an die Gurgel gehen.

Schnittstelle A

print("<?xml version = "1.0" encoding="UTF-8" standalone="yes"?>
        <Message version="1.0">
            <ClientID>11111</ClientID>
            <PassPhrase>shjfkh</PassPhrase>
            <Request Type="sms" Refno="10" ToAddress="27732687745332">
                <Content>
                      hello world
                </Content>
            </Request>
        </Message> ");

Schnittstelle B

 print("<?xml version = "1.0" encoding="UTF-8" standalone="yes"?>
    <Message>
        <mmtag name="Version">1.0</mmtag>
        <mmtag name="ClientID">1001</mmtag>
        <mmtag name="RefNO">120</mmtag>
        <mmtag name="Encoding">base64</mmtag>
        <mmtag name="Type">SMS</mmtag>
        <mmtag name="Content">hello world</mmtag>
        <mmtag name="MSISDN">27781010102</mmtag>        
    </Message>");

Welche der beiden Beispiele würde sich Ihrer Meinung nach am besten für unsere API-Schnittstelle eignen, unabhängig von der Technologie im Backend? Bitte begründen Sie Ihre Antwort, wenn Sie sich für eines entscheiden.

Answer 1

Schnittstelle A... Ich bin ein Fan von Attributen über Tag-Inhalt.

Answer 2

Ich würde sagen, dass der zweite Fall schwieriger zu lesen ist, weil er Implementierungsdetails in einem Attribut versteckt.

Answer 3

Schnittstelle A, aus all den Gründen, die bereits von anderen genannt wurden. Ich würde jedoch vorschlagen, dass ToAddress ein Element ist, so dass dieselbe Nachricht an mehrere ToAddress gesendet werden kann:

<Request Type="sms" Refno="10">
  <To>27732687745332</To>
  <To>1234567890</To>
  <Content>Hello world</Content>
  </Request>

Als Erbsenzähler würde ich vorschlagen, dass die Attribute einen führenden Kleinbuchstaben und die Elemente einen führenden Großbuchstaben verwenden... aber das ist nur meine Meinung.