Bei einem Datentyp handelt es sich um eine Beschreibung der Daten, die über das Netzwerk ausgetauscht werden. Er kann in der gesamten API-Version wiederverwendet werden.
Prozedur
Klicken Sie auf die Schaltfläche + in der oberen rechten Ecke des linken Fensterbereichs.
InformationshinweisTipp: Wenn Sie den Datentyp direkt in einer zuvor erstellten Section erstellen möchten, können Sie dazu auf die +-Schaltfläche rechts neben dem Section-Namen klicken.
Klicken Sie auf Data type (Datentyp).
Geben Sie einen Name (Namen) für den Datentyp ein, z. B. Contact (Kontakt), sowie nach Bedarf eine Description (Beschreibung).
Optional: Wählen Sie die Section aus, in die Sie den Datentyp aufnehmen möchten.
Wenn Sie über ein bereits vorhandenes JSON-Beispiel für Ihren Datentyp verfügen, können Sie dieses zur Generierung der Eigenschaften heranziehen. Klicken Sie dazu auf Generate from JSON example (Ausgehend von JSON-Beispiel generieren).
Geben Sie Ihr Beispiel ein und klicken Sie dann auf Generate (Generieren).
Example
Dadurch werden alle im Beispiel enthaltenen Eigenschaften im Datentyp erstellt.
Um die Eigenschaften manuell hinzuzufügen, wählen Sie Type (Typ) aus.
Der Standardtyp ist object (Objekt). Wenn Sie darauf klicken, werden alle verfügbaren Typen angezeigt.
Klicken Sie auf Add property (Eigenschaft hinzufügen), um eine neue Eigenschaft zu erstellen, und geben Sie Name und Type (Typ) ein.
Optional: Stellen Sie die Option Required (Erforderlich) auf Yes (Ja) ein, wenn die Eigenschaft erforderlich ist.
Fügen Sie nach Bedarf eine Description (Beschreibung) hinzu und klicken Sie auf more attributes (Mehr Attribute), um weitere Informationen für Ihren Datentyp hinzuzufügen.
Example
Fügen Sie so viele Eigenschaften wie erforderlich hinzu und klicken Sie anschließend auf Save (Speichern).
Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!