OASValidation-Richtlinie

Sie sehen die Dokumentation zu Apigee Edge.
Rufen Sie die Apigee X-Dokumentation auf. weitere Informationen

Über die OASValidation-Richtlinie

Mit der OASValidation-Richtlinie (OpenAPI-Spezifikation) können Sie eine eingehende Anfrage oder Antwortnachricht mit einer OpenAPI 3.0-Spezifikation (JSON oder YAML) prüfen. Siehe Welche Inhalte werden validiert?

Die OASValidation-Richtlinie gibt den Namen der OpenAPI-Spezifikation an, die für die Validierung verwendet werden soll, wenn der Schritt, mit dem die Richtlinie verknüpft ist, ausgeführt wird. Die OpenAPI-Spezifikation wird als Ressource im folgenden Standardspeicherort im API-Proxy-Bundle gespeichert: apiproxy/resources/oas. Die OpenAPI-Spezifikation muss die Erweiterung .json, .yml und .yaml haben.

Fügen Sie einem API-Proxy-Bundle mithilfe der UI oder API eine OpenAPI-Spezifikation als Ressource hinzu, wie unter Ressourcen verwalten beschrieben.

Welche Inhalte werden validiert?

In der folgenden Tabelle wird der Inhalt der Anfragenachricht, der durch die OASValidation-Richtlinie validiert ist, nach Komponente zusammengefasst.

Komponenten Anfragevalidierung
Basispfad Validiert den vom API-Proxy definierten Basispfad und ignoriert den in der OpenAPI-Spezifikation angegebenen Basispfad.
Pfad Validiert, dass der Anfragepfad (ohne den Basispfad) mit einem der in der OpenAPI-Spezifikation definierten Pfadmuster übereinstimmt.
Verb Validiert, dass das Verb für den Pfad in der OpenAPI-Spezifikation definiert ist.
Nachrichtentext der Anfrage
  • Validiert, dass der Nachrichtentext in der Anfrage vorhanden ist, falls erforderlich.
  • Er validiert den Nachrichtentext anhand des Anfragetextschemas des Vorgangs in der OpenAPI-Spezifikation. Konfigurieren Sie diese Option mit <ValidateMessageBody>.

Hinweis: Die Richtlinie validiert den Nachrichtentext der Anfrage anhand der OpenAPI-Spezifikation nur dann, wenn der Inhaltstyp auf application/json eingestellt ist. Wenn der Inhaltstyp nicht auf application/json gesetzt ist, ist die Validierung des Nachrichtentexts der Anfrage automatisch erfolgreich, ohne dass der Inhalt tatsächlich validiert wurde.

Parameters
  • Validiert, dass die erforderlichen Parameter in der Anfrage vorhanden sind, einschließlich der Pfad-, Header-, Abfrage- und Cookie-Parameter.
  • Validiert, dass die Parameterwerte mit den in der OpenAPI-Spezifikation definierten übereinstimmen.
  • Überprüft optional, ob in der Anfrage Parameter vorhanden sind, die nicht in der OpenAPI-Spezifikation definiert sind. Konfigurieren Sie diese Option mit <AllowUnspecifiedParameters>.

In der folgenden Tabelle wird der Inhalt der Antwortnachricht, der durch die OASValidation-Richtlinie validiert ist, nach Komponente zusammengefasst.

Komponenten Antwortvalidierung
Pfad Validiert, dass der Anfragepfad (ohne den Basispfad) mit einem der in der OpenAPI-Spezifikation definierten Pfadmuster übereinstimmt.
Verb Validiert, dass das Verb für den Pfad in der OpenAPI-Spezifikation definiert ist.
Nachrichtentext der Antwort
  • Validiert, dass der Nachrichtentext in der Antwort vorhanden ist, falls erforderlich.
  • Validiert, dass die Antwortheader in der OpenAPI-Spezifikation in der Antwortnachricht enthalten sind und der Wert der Antwortheader mit dem Schema übereinstimmt.
  • Überprüft optional den Nachrichtentext anhand des Antworttextschemas des Vorgangs in der OpenAPI-Spezifikation. Konfigurieren Sie diese Option mit <ValidateMessageBody>.

Samples

Folgende Beispiele zeigen einige Möglichkeiten, wie Sie die OASValidation-Richtlinie verwenden können, um Nachrichten anhand einer OpenAPI 3.0-Spezifikation zu prüfen.

Anfragenachricht validieren

Im folgenden Beispiel validiert die Richtlinie myoaspolicy den Text der Anfragenachricht anhand des Schemas für den Nachrichtentext des Vorgangs, das in der OpenAPI-Spezifikation my-spec.json definiert ist. 

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.json</OASResource>
   <Options>
      <ValidateMessageBody>true</ValidateMessageBody>
   </Options>
   <Source>request</Source>
</OASValidation>

Stimmt der Nachrichtentext nicht mit der OpenAPI-Spezifikation überein, so wird ein policies.oasvalidation.Failed-Fehler zurückgegeben.

Parameter validieren

Im folgenden Beispiel wird die Richtlinie so konfiguriert, dass sie fehlschlägt, falls ein Header, eine Abfrage oder ein Cookie-Parameter in der Anfrage angegeben wird, der in der OpenAPI-Spezifikation nicht definiert ist.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
         <Query>false</Query>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

Element <OASValidation>

Definiert die OASValidation-Richtlinie (OpenAPI Specification Validation).

Standardwert Siehe unten, Tab Standardrichtlinie
Erforderlich? Erforderlich
Typ Komplexes Objekt
Übergeordnetes Element –
Untergeordnete Elemente <DisplayName>
<OASResource>
<Source>
<Options>
<Source>

Syntax

Das <OASValidation>-Element verwendet die folgende Syntax:

<OASValidation
  continueOnError="[true|false]"
  enabled="[true|false]"
  name="policy_name"
>
    <!-- All OASValidation child elements are optional except OASResource -->
    <DisplayName>policy_display_name</DisplayName>
    <OASResource>validation_JSON_or_YAML</OASResource>
    <Options>
        <ValidateMessageBody>[true|false]</ValidateMessageBody>
        <AllowUnspecifiedParameters>
            <Header>[true|false]</Header>
            <Query>[true|false]</Query>
            <Cookie>[true|false]</Cookie>
        </AllowUnspecifiedParameters>
    </Options>
    <Source>message_to_validate</Source>
</OASValidation>

Standardrichtlinie

Das folgende Beispiel zeigt die Standardeinstellungen, wenn Sie in der Apigee-UI Ihrem Ablauf eine OASValidation-Richtlinie hinzufügen:

<OASValidation continueOnError="false" enabled="true" name="OpenAPI-Spec-Validation-1">
    <DisplayName>OpenAPI Spec Validation-1</DisplayName>
    <Properties/>
    <Source>request</Source>
    <OASResource>oas://OpenAPI-Spec-Validation-1.yaml</OASResource>
</OASValidation>

Dieses Element hat folgende Attribute, die allen Richtlinien gemeinsam sind:

Attribut Standard Erforderlich? Beschreibung
name – Erforderlich

Der interne Name der Richtlinie. Der Wert des Attributs name kann Buchstaben, Ziffern, Leerzeichen, Bindestriche, Unterstriche und Punkte enthalten. Dieser Wert darf 255 Zeichen nicht überschreiten.

Optional können Sie das Element <DisplayName> verwenden, um die Richtlinie im Proxy-Editor der Verwaltungs-UI mit einem anderen Namen in einer natürlichen Sprache zu versehen.
continueOnError falsch Optional Ist das Element auf "false" gesetzt, wird ein Fehler zurückgegeben, wenn eine Richtlinie fehlschlägt. Dies ist für die meisten Richtlinien das erwartete Verhalten. Ist das Element auf "true" gesetzt, wird die Ausführung des Ablaufs auch nach dem Fehlschlagen einer Richtlinie fortgesetzt.
enabled wahr Optional Auf "true" setzen, um die Richtlinie durchzusetzen. Auf "false" setzen, um die Richtlinie zu "deaktivieren". Die Richtlinie wird nicht durchgesetzt, selbst wenn sie mit einem Ablauf verknüpft ist.
async   falsch Eingestellte Funktionen Dieses Attribut wurde verworfen.

Verweis auf untergeordnetes Element

In diesem Abschnitt werden die untergeordneten Elemente von <OASValidation> beschrieben.

<DisplayName>

Wird zusätzlich zum Attribut name verwendet, um die Richtlinie im Proxy-Editor der Verwaltungs-UI mit einem anderen, natürlicher klingenden Namen zu versehen.

Das Element <DisplayName> ist für alle Richtlinien gleich.

Standardwert –
Erforderlich/Optional? Optional. Wenn Sie <DisplayName> weglassen, wird der Wert des Attributs name der Richtlinie verwendet.
Typ String
Übergeordnetes Element <PolicyElement>
Untergeordnete Elemente Keine

Das <DisplayName>-Element verwendet die folgende Syntax:

Syntax

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

Beispiel

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

Das <DisplayName>-Element hat keine Attribute oder untergeordneten Elemente.

<OASResource>

Gibt die OpenAPI-Spezifikation an, gegen die validiert werden soll. Sie können diese Datei speichern:

  • Im API-Proxy-Bereich unter /apiproxy/resources/oas im API-Proxy-Bundle
  • Im Abschnitt Resources der Navigatoransicht des API-Proxy-Editors.

Weitere Informationen finden Sie unter Ressourcen verwalten.

Sie können die OpenAPI-Spezifikation mithilfe einer Nachrichtenvorlage angeben, beispielsweise {oas.resource.url}. In diesem Fall wird der Wert der Flussvariablen oas.resource.url (in geschweiften Klammern) ausgewertet und zur Laufzeit durch den Nutzlaststring ersetzt. Weitere Informationen finden Sie unter SMS-Vorlagen.

Standardwert Keine
Erforderlich? Erforderlich
Typ String
Übergeordnetes Element <OASValidation>
Untergeordnete Elemente Keine

Syntax

Das <OASResource>-Element verwendet die folgende Syntax:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   ...
</OASValidation>

Beispiel

Folgendes Beispiel verweist auf die Spezifikation my-spec.yaml, die unter /apiproxy/resources/oas im API-Proxy-Bundle gespeichert ist:

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
</OASValidation>

Das <OASResource>-Element hat keine Attribute oder untergeordneten Elemente.

<Options>

Konfiguriert Optionen für die Richtlinie.

Standardwert –
Erforderlich? Optional
Typ Komplexer Typ
Übergeordnetes Element <OASValidation>
Untergeordnete Elemente <ValidateMessageBody>
<AllowUnspecifiedParameters>

Syntax

Das <Options>-Element verwendet die folgende Syntax:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <ValidateMessageBody>[true|false]</ValidateMessageBody>
      <AllowUnspecifiedParameters>
         <Header>[true|false]</Header>
         <Query>[true|false]</Query>
         <Cookie>[true|false]</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

Beispiel

Im folgenden Beispiel werden die Optionen für die Richtlinie konfiguriert. Jede dieser Optionen wird im Folgenden näher beschrieben.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <ValidateMessageBody>false</ValidateMessageBody>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
         <Query>false</Query>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<ValidateMessageBody>

Gibt an, ob der Richtlinientext in der OpenAPI-Spezifikation mit dem Anfragetexttext des Vorgangs abgeglichen werden soll. Setzen Sie diesen Wert auf true, um den Inhalt des Nachrichteninhalts zu validieren. Setzen Sie diesen Wert auf false, um nur zu prüfen, ob der Nachrichtentext vorhanden ist.

Sie können festlegen, ob die Ablaufausführung nach einem Validierungsfehler fortgesetzt werden soll. Dazu setzen Sie das Attribut continueOnError für das Element <OASValidation> auf true.

Standardwert false
Erforderlich? Optional
Typ Boolesch
Übergeordnetes Element <Options>
Untergeordnete Elemente Keine

Syntax

Das <ValidateMessageBody>-Element verwendet die folgende Syntax:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
         <ValidateMessageBody>[true|false]</ValidateMessageBody>
   </Options>
   ...
</OASValidation>

Beispiel

Im folgenden Beispiel wird die Validierung des Nachrichtentexts aktiviert:

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <ValidateMessageBody>true</ValidateMessageBody>
   </Options>
</OASValidation>

<AllowUnspecifiedParameters>

Konfiguriert das Verhalten der Richtlinie, wenn die Anfrage Header-, Abfrage- oder Cookie-Parameter enthält, die nicht in der OpenAPI-Spezifikation definiert sind.

Standardwert –
Erforderlich? Optional
Typ Komplexer Typ
Übergeordnetes Element <Options>
Untergeordnete Elemente <Header>
<Query>
<Cookie>

Syntax

Das <AllowUnspecifiedParameters>-Element verwendet die folgende Syntax:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>[true|false]</Header>
         <Query>[true|false]</Query>
         <Cookie>[true|false]</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

Beispiel

Im folgenden Beispiel wird die Richtlinie so konfiguriert, dass sie fehlschlägt, falls ein Header, eine Abfrage oder ein Cookie-Parameter in der Anfrage angegeben wird, der in der OpenAPI-Spezifikation nicht definiert ist.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
         <Query>false</Query>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

Konfiguriert das Verhalten der Richtlinie, wenn in der Anfrage Headerparameter vorhanden sind, die nicht in der OpenAPI-Spezifikation definiert sind.

Damit Headerparameter in der Anfrage angegeben werden können, die nicht in der OpenAPI-Spezifikation definiert sind, setzen Sie diesen Parameter auf wahr. Setzen Sie andernfalls diesen Parameter auf false, damit die Richtlinienausführung fehlschlägt.

Standardwert wahr
Erforderlich? Boolesch
Typ Komplexer Typ
Übergeordnetes Element <AllowUnspecifiedParameters>
Untergeordnete Elemente Keine

Syntax

Das <Header>-Element verwendet die folgende Syntax:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>[true|false]</Header>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

Beispiel

Im folgenden Beispiel wird die Richtlinie so konfiguriert, dass ein Headerparameter in der Anfrage angegeben wird, der nicht in der OpenAPI-Spezifikation definiert ist.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<Query> (<AllowUnspecifiedParameters> untergeordnet)

Konfiguriert das Verhalten der Richtlinie für den Fall, dass die Anfrage Abfrageparameter enthält, die nicht in der OpenAPI-Spezifikation definiert sind.

Damit Abfrageparameter in der Anfrage angegeben werden können, die nicht in der OpenAPI-Spezifikation definiert sind, setzen Sie diesen Parameter auf wahr. Setzen Sie andernfalls diesen Parameter auf false, damit die Richtlinienausführung fehlschlägt.

Standardwert wahr
Erforderlich? Boolesch
Typ Komplexer Typ
Übergeordnetes Element <AllowUnspecifiedParameters>
Untergeordnete Elemente Keine

Syntax

Das <Query>-Element verwendet die folgende Syntax:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Query>[true|false]</Query>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

Beispiel

Im folgenden Beispiel wird die Richtlinie so konfiguriert, dass ein Abfrageparameter in der Anfrage angegeben wird, der nicht in der OpenAPI-Spezifikation definiert ist.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Query>false</Query>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

Konfiguriert das Verhalten der Richtlinie für den Fall, dass die Anfrage Cookieparameter enthält, die nicht in der OpenAPI-Spezifikation definiert sind.

Damit Cookieparameter in der Anfrage angegeben werden können, die nicht in der OpenAPI-Spezifikation definiert sind, setzen Sie diesen Parameter auf wahr. Setzen Sie andernfalls diesen Parameter auf false, damit die Richtlinienausführung fehlschlägt.

Standardwert wahr
Erforderlich? Boolesch
Typ Komplexer Typ
Übergeordnetes Element <AllowUnspecifiedParameters>
Untergeordnete Elemente Keine

Syntax

Das <Cookie>-Element verwendet die folgende Syntax:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Query>[true|false]</Query>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

Beispiel

Im folgenden Beispiel wird die Richtlinie so konfiguriert, dass ein Abfrageparameter in der Anfrage angegeben wird, der nicht in der OpenAPI-Spezifikation definiert ist.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<Source>

JSON-Nachricht, die im Hinblick auf Angriffe über JSON-Nutzlasten ausgewertet werden soll. Dies ist meistens auf request gesetzt, da Sie in der Regel eingehende Anfragen von Client-Apps evaluieren müssen. Durch die Einstellung auf response werden Antwortnachrichten bewertet. Durch die Einstellung auf message wird automatisch die Anfragenachricht bewertet, wenn die Richtlinie an den Anfrageablauf angehängt wird. Wenn die Richtlinie an den Antwortablauf angehängt wird, wird bei dieser Einstellung automatisch die Antwortnachricht bewertet.

Standardwert Anfrage
Erforderlich? Optional
Typ String
Übergeordnetes Element <Source>
Untergeordnete Elemente Keine

Syntax

Das <Source>-Element verwendet die folgende Syntax:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Source>[message|request|response]</Source>
   ...
</OASValidation>

Beispiel

Im folgenden Beispiel wird die Anfragenachricht automatisch ausgewertet, wenn die Richtlinie an den Anfrageablauf angehängt wird, und wenn die Richtlinie an den Antwortablauf angehängt wird, wird die Antwortnachricht ausgewertet:

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Source>message</Source>
</OASValidation>

Das <Source>-Element hat keine Attribute oder untergeordneten Elemente.

Schemas

Jeder Richtlinientyp wird durch ein XML-Schema (.xsd) definiert. Zu Referenzzwecken sind Richtlinienschemas auf GitHub verfügbar.

Fehlercodes

In diesem Abschnitt werden die Fehlercodes und Fehlermeldungen beschrieben, die zurückgegeben werden, sowie die Fehlervariablen, die von Edge festgelegt werden, wenn diese Richtlinie einen Fehler auslöst. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode HTTP-Status Ursache
steps.oasvalidation.Failed 500 Der Text der Anfragenachricht kann nicht mit der bereitgestellten OpenAPI-Spezifikation validiert werden.
steps.oasvalidation.SourceMessageNotAvailable 500

Die im Element <Source> der Richtlinie angegebene Variable liegt entweder außerhalb des Gültigkeitsbereichs oder kann nicht aufgelöst werden.
steps.oasvalidation.NotMessageVariable 500

Für das <Source>-Element ist eine Variable festgelegt, die nicht vom Typ message ist.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Fehlername Ursache
ResourceDoesNotExist Die OpenAPI-Spezifikation, auf die im Element <OASResource> verwiesen wird, ist nicht vorhanden.
ResourceCompileFailed Die in der Bereitstellung enthaltene OpenAPI-Spezifikation enthält Fehler, die verhindern, dass sie kompiliert werden. Dies weist im Allgemeinen darauf hin, dass die Spezifikation keine korrekt formatierte OpenAPI-Spezifikation 3.0 darstellt.
BadResourceURL Die im Element <OASResource> angegebene OpenAPI-Spezifikation kann nicht verarbeitet werden. Dieser Fehler kann auftreten, wenn die Datei keine JSON- oder YAML-Datei ist oder die Datei-URL nicht korrekt angegeben wurde.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen Wo Beispiel
fault.name="fault_name" fault_name ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes. fault.name Matches "ResourceDoesNotExist"
oasvalidation.policy_name.failed policy_name ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat. oasvalidation.myoaspolicy.failed = true

Unterstützte OpenAPI-Spezifikationsfeatures

Die OASValidation-Richtlinie unterstützt die OpenAPI-Spezifikationsfeatures, die in der folgenden Tabelle nach Kategorie zusammengefasst sind. Die nicht unterstützten Features sind ebenfalls aufgelistet.

Kategorie Unterstützt Nicht unterstützt
Datentypformate boolesch
Datum
Datum-Uhrzeit
double
email
float
int32/int64
ipv4/ipv6
md5
sha1/sha256/sha512
string
uri
uri-template
uuid
 Binär
Byte
Passwort
Diskriminator-Objekt Zuordnung
propertyName 		–
Medientypobjekt schema codierung
beispiel
beispiele
Vorgangsobjekt Parameter
requestBody
Antworten
security (teilweise Unterstützung) 		Callbacks
eingestellt
Server
Parameterobjekt „allowEmptyValue“
in (query, header, path)
erforderliche
Antworten
Schema
Stil (deepObject, form, formmatrix, label, pipeDelimited, simple, spaceDelimited)

Hinweis: deepObject unterstützt nur Stringparameter. Arrays und verschachtelte Objekte werden nicht unterstützt. 		allowedReserviert
eingestellt
Beispiel
Beispiele
Inhalt
Pfadobjekt löschen
get
head
options
parameters
patch
post
put
trace
variablen 		Server
Anfragetextobjekt application/json
application/hal+json
application/x-www-form-urlEncrypt (encoding-Objekt wird nicht unterstützt)
Inhalt
erforderlich 		application/xml
multipart/form-data
text/plain
text/xml
Antwortobjekt application/json
application/hal+json
application/x-www-form-urlencoded (encoding-Objekt wird nicht unterstützt)
content
Header 		application/xml
Links
text/plain
text/xml
Antwortenobjekt Standard
HTTP-Statuscode 		–
Schema-Objekt $ref
additionalProperties (nur Variante des booleschen Flags)
allOf (wird ignoriert, wenn additionalProperties den Wert false hat)
anyOf
enum
officialMaximum/ExklusivMinimum
format
items
maxLength/minLength
maxProperties/minProperties
multipleOf
not
nullable
oneOf
pattern
uniqueItem
typerequired




 verworfen
Beispiel
readOnly
writeOnly
xml
Sicherheitsschema-Objekt in (header, query) (wird ignoriert, wenn type gleich http ist)
name
Typ (apiKey, http) 		BearerFormat-
Abläufe
openIdConnectUrl
schema
Serverobjekt url-
variablen 		Mehrere Serverdefinitionen

Weitere Informationen