Kenmerken van gegevenstypen gebruiken

Naam

Naam van het gegevenstype of de eigenschap.

Hoofdelement voor de definitie van het gegevenstype of de eigenschap.

Beschrijving

Beschrijving van de eigenschap.

description

Vereist

Booleaanse waarde, definieert of een eigenschap vereist of optioneel is.

• OAS 3.0 en Swagger 2.0: Vereiste eigenschappen worden vermeld in een required element op objectniveau.
• RAML: required

Beperkingen

Definieert of de eigenschap beschikbaar is in de aanvraag, het antwoord of beide.

• OAS 3.0: Eigenschappen kunnen een writeOnly of readOnly element hebben met een booleaanse waarde.
• Geen overeenkomstig element in Swagger 2.0 of RAML 1.0.

Voorbeelden

Voorbeeldwaarden voor de eigenschap. Ze kunnen worden geretourneerd bij het gebruik van een API-mock.

• OAS 3.0 en Swagger 2.0: De eerste waarde wordt gebruikt in het example element. Andere waarden worden genegeerd.
  InformatieOpmerking: De OAS 3.0-specificatie bevat een examples element, maar dit wordt niet ondersteund door API Designer.
• RAML: examples

Aanvullende eigenschappen

Booleaanse waarde, definieert of het object eigenschappen accepteert die niet zijn opgenomen in de definitie van het gegevenstype. Dit is standaard ingeschakeld.

additionalProperties

Min. items en Max. items

Minimum- en maximumaantal items in een array.

minItems en maxItems

Unieke items

Booleaanse waarde, definieert of elk item in een array uniek moet zijn.

• OAS 3.0 en RAML 1.0: uniqueItems
• Geen overeenkomstig element in Swagger 2.0.

Enum

Mogelijke waarden voor de eigenschap.

enum

Min. lengte en Max. lengte

Minimum- en maximumaantal bytes in de waarde.

minLength en maxLength

Patroon

Reguliere expressie waaraan de waarde moet voldoen.

pattern

Standaard

Waarde die moet worden gebruikt als er geen waarde is opgegeven.

default

Enum

Mogelijke waarden voor de eigenschap.

enum

Indeling

Indeling die moet worden gebruikt voor een nummer of integer.

format

Minimum en Maximum

Minimum- en maximumwaarde van een nummer of integer.

minimum en maximum

Standaard

Waarde die moet worden gebruikt als er geen waarde is opgegeven.

default

Enum

Mogelijke waarden voor de eigenschap.

enum

Standaard

Waarde die moet worden gebruikt als er geen waarde is opgegeven.

default

Enum

Mogelijke waarden voor de eigenschap.

enum

Indeling

Indeling die moet worden gebruikt voor een datetime.

• RAML 1.0: format
• OAS 3.0: Datetime-eigenschappen in OAS 3.0 worden gedefinieerd als strings met de indeling date-time. De standaard datetime-indeling die wordt gebruikt is RFC3339, maar als rfc2616 is geselecteerd, wordt een aangepaste indeling date-time-rfc2616 gebruikt.
• Swagger 2.0: Datetime-eigenschappen worden op dezelfde manier gedefinieerd als in OAS 3.0, maar Swagger 2.0 ondersteunt geen aangepaste indelingen. Ze worden geïnterpreteerd als RFC3339, ongeacht de geselecteerde indeling.

Min. lengte en Max. lengte

Minimum- en maximumaantal bytes in de waarde.

minLength en maxLength

Bestandstypen

Type bestand dat moet worden gebruikt, in de indeling */*. Bijvoorbeeld: image/png

• RAML 1.0: fileTypes