Eine Codierungsdefinition bearbeiten

Eine Codierungsdefinition definiert eine Zuordnung zwischen einer bestimmten Schemaeigenschaft und den zugehörigen Codierungsinformationen.

Vorbereitende Schritte

Öffnen Sie das Detailformular für eine Codierungsdefinition, wenn Sie eine Inhaltsdefinition konfigurieren; siehe Inhaltsdefinition bearbeiten.

Informationen zu dieser Task

Hinweis:
  • Diese Task bezieht sich auf die Konfiguration einer OpenAPI 3.0-API-Definition. Details zum Konfigurieren einer OpenAPI 2.0 -API-Definition finden Sie unter Bearbeiten einer OpenAPI 2.0 -API-Definition.
  • OpenAPI 3.0 -APIs werden nur mit dem DataPower® API Gatewayunterstützt, nicht mit dem DataPower Gateway (v5 compatible).
  • Details zu aktuellen OpenAPI 3.0 -Unterstützungseinschränkungen finden Sie unter OpenAPI 3.0 -Unterstützung in IBM® API Connect.

Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen.

Sie können jederzeit direkt zur zugrunde liegenden OpenAPI -YAML-Quelle wechseln, indem Sie auf das Symbol Quelle Symbol für OpenAPI -Quelleklicken. Klicken Sie auf das Symbol Formular Formularsymbol, um zum Designformular zurückzukehren.

Vorgehensweise

  1. Geben Sie die folgenden Informationen an:
    • Name: Der Name der Schemaeigenschaft. Um den Namen zu ändern, klicken Sie auf Aktualisierenund anschließend auf Speichern .
    • Inhaltstyp: Der Inhaltstyp für das Codieren der Eigenschaft, z. B.:
      • application/xml; charset=utf-8
      • image/png, image/jpeg.
    • Header: Eine Zuordnung, die ermöglicht, dass zusätzliche Informationen als Header angegeben werden.

      Wenn Sie einen neuen Header hinzufügen möchten, klicken Sie auf Hinzufügen. Informationen hierzu finden Sie unter Header erstellen.

      Wenn Sie einen vorhandenen Header bearbeiten möchten, klicken Sie auf den Headernamen und lesen Sie anschließend Header bearbeiten.

    • Stil: Beschreibt, wie der Eigenschaftswert abhängig vom Typ des Eigenschaftswerts serialisiert wird. Wählen Sie eine der folgenden Optionen aus:
      • form: Eigenschaften des Formularstils, definiert durch RFC6570.
      • spaceDelimited: Durch Leerzeichen voneinander getrennte Arraywerte.
      • pipeDelimited: Durch senkrechte Striche (Pipes) voneinander getrennte Arraywerte.
      • deepObject: Bietet eine einfache Möglichkeit, verschachtelte Objekte unter Verwendung von Formulareigenschaften wiederzugeben.
    • Zerlegen: Wenn diese Option ausgewählt ist, generieren Eigenschaftswerte des Typs array oder object separate Eigenschaften für jeden Wert des Arrays oder Schlüssel/Wert-Paars der Zuordnung.
    • Reservierte zulassen: Legt fest, ob der Eigenschaftswert reservierte Zeichen zulassen soll, wie durch RFC3986 (:/?#[]@!$&'()*+,;=) definiert, ohne Prozentcodierung eingeschlossen werden.
  2. Klicken Sie anschließend auf Speichern .

Nächste Schritte

Falls erforderlich, verwenden Sie den Navigationspfad, um zu einer anderen Position in der Hierarchie des Objekts zu navigieren, an dem Sie arbeiten.