# Verwenden von Datentypattributen

In der folgenden Tabelle werden die Attribute beschrieben, die für verschiedene Datentypen definiert werden können.

## Allgemeine Attribute

Diese Attribute sind für alle Datentypen verfügbar.

| Feld | Beschreibung | Entsprechendes OAS/Swagger- und RAML-Element |
| --- | --- | --- |
| Name | Name des Datentyps oder der Eigenschaft. | Stammelement für die Datentyp- oder Eigenschaftsdefinition. |
| Description (Beschreibung) | Beschreibung der Eigenschaft | description |
| Required (Erforderlich) | Boolescher Wert. Gibt an, ob eine Eigenschaft erforderlich oder optional ist. | <ul> <li>OAS 3.0 und Swagger 2.0: Erforderliche Eigenschaften werden in einem <span>required</span>-Element (erforderlich) auf Objektebene aufgelistet.</li> <li>RAML: <span>required</span> (erforderlich)                   </li> </ul> |
| Restrictions (Einschränkungen) | Legt fest, ob die Eigenschaft im Request, in der Antwort oder in beidem verfügbar ist. | <ul> <li>OAS 3.0: Eigenschaften können über ein <span>writeOnly</span>- oder <span>readOnly</span>-Element (Nur Schreiben / Nur Lesen) mit einem booleschen Wert verfügen.</li> <li>Kein entsprechendes Element in Swagger 2.0 oder RAML 1.0.</li> </ul> |
| Examples (Beispiele) | Beispielwerte für die Eigenschaft. Diese Werte können bei Verwendung eines API-Mocks zurückgegeben werden. | <ul> <li>OAS 3.0 und Swagger 2.0: Der erste Wert wird in einem <span>example</span>-Element (Beispiel) verwendet. Andere Werte werden ignoriert. <div><span>Informationshinweis</span><span>Anmerkung:</span> Die OAS 3.0-Spezifikation umfasst ein <span>examples</span>-Element (Beispiele), dieses wird von <span>Talend Cloud API Designer</span> jedoch nicht unterstützt.</div> </li> <li>RAML: <span>examples</span> (Beispiele)                   </li> </ul> |

## Objektattribute

| Feld | Beschreibung | Entsprechendes OAS/Swagger- und RAML-Element |
| --- | --- | --- |
| Additional properties (Zusätzliche Eigenschaften) | Boolescher Wert. Gibt an, ob das Objekt Eigenschaften akzeptiert, die nicht in der Datentypdefinition enthalten sind. Diese Option ist standardmäßig aktiviert. | additionalProperties (zusätzliche Eigenschaften) |

## Array-Attribute

| Feld | Beschreibung | Entsprechendes OAS/Swagger- und RAML-Element |
| --- | --- | --- |
| Min items (Min. Elemente) und Max items (Max. Elemente) | Minimale und maximale Anzahl an Elementen in einem Array. | minItems (min. Elemente) und maxItems (max. Elemente) |
| Unique items (Eindeutige Elemente) | Boolescher Wert. Gibt an, ob jedes Element in einem Array eindeutig sein muss. | <ul> <li>OAS 3.0 und RAML 1.0: <span>uniqueItems</span> (eindeutige Elemente)                   </li> <li>Kein entsprechendes Element in Swagger 2.0.</li> </ul> |

## Zeichenfolgenattribute

| Feld | Beschreibung | Entsprechendes OAS/Swagger- und RAML-Element |
| --- | --- | --- |
| Enum | (Enumeration/Aufzählung) Mögliche Werte für die Eigenschaft. | enum |
| Min length (Min. Länge) und Max length (Max. Länge) | Minimale und maximale Anzahl an Bytes im Wert. | minLength (min. Länge) und maxLength (max. Länge) |
| Pattern (Muster) | Regulärer Ausdruck, dem der Wert entsprechen muss. | pattern (Muster) |
| Default (Standard) | Wert, der verwendet wird, wenn ein Wert nicht bereitgestellt wird. | default (Standard) |

## Zahlen- und Ganzzahlenattribute

| Feld | Beschreibung | Entsprechendes OAS/Swagger- und RAML-Element |
| --- | --- | --- |
| Enum | (Enumeration/Aufzählung) Mögliche Werte für die Eigenschaft. | enum |
| Format | Für eine Zahl bzw. eine Ganzzahl (Integer) zu verwendendes Format. | format |
| Minimum und Maximum | Mindest- und Höchstwert für eine Zahl bzw. Ganzzahl (Integer). | minimum und maximum |
| Default (Standard) | Wert, der verwendet wird, wenn ein Wert nicht bereitgestellt wird. | default (Standard) |

## Datums- und Uhrzeitattribute

| Feld | Beschreibung | Entsprechendes OAS/Swagger- und RAML-Element |
| --- | --- | --- |
| Enum | (Enumeration/Aufzählung) Mögliche Werte für die Eigenschaft. | enum |
| Default (Standard) | Wert, der verwendet wird, wenn ein Wert nicht bereitgestellt wird. | default (Standard) |

## Datums-/Uhrzeitattribute

| Feld | Beschreibung | Entsprechendes OAS/Swagger- und RAML-Element |
| --- | --- | --- |
| Enum | (Enumeration/Aufzählung) Mögliche Werte für die Eigenschaft. | enum |
| Format | Für eine Datums-/Uhrzeitangabe (datetime) zu verwendendes Format. | <ul> <li>RAML 1.0: <span>format</span> (Format)                   </li> <li>OAS 3.0: Die Datums/Uhrzeiteigenschaften  in OAS 3.0 werden als Zeichenfolgen (Strings) im Format <span>date-time</span> (Datum-Uhrzeit) definiert. Standardmäßig wird das Datums-/Uhrzeitformat RFC3339 verwendet, wenn jedoch <kbd>rfc2616</kbd> ausgewählt wird, wird ein benutzerdefiniertes <span>date-time-rfc2616</span>-Format verwendet.</li> <li>Swagger 2.0: Die Datums-/Uhrzeiteigenschaften werden wie in in OAS 3.0 definiert, Swagger 2.0 bietet jedoch keine Unterstützung für benutzerdefinierte Formate.                             Diese werden als FC3339 interpretiert, ungeachtet des jeweils ausgewählten Formats.</li> </ul> |

## Dateiattribute

| Feld | Beschreibung | Entsprechendes OAS/Swagger- und RAML-Element |
| --- | --- | --- |
| Min length (Min. Länge) und Max length (Max. Länge) | Minimale und maximale Anzahl an Bytes im Wert. | minLength (min. Länge) und maxLength (max. Länge) |
| File types (Dateitypen) | Zu verwendender Dateityp im Format \*/\*. Beispiel: image/png | <ul> <li>RAML 1.0: <span>fileTypes</span> (Dateitypen)                   </li> </ul> |