Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Organisieren Ihrer API-Liste

Konfigurieren Sie Ihr Portal für eine spezifische Anzeige der API-Liste.

Warum und wann dieser Vorgang ausgeführt wird

Standardmäßig werden alle APIs im Portal in alphabetischer Reihenfolge angezeigt. Sie können eine Liste erstellen, die Ihnen eine Sortierung und Gruppierung ermöglicht.

Prozedur

  1. Öffnen Sie in Ihrem API-Portal-Repository die Datei config.toml.
  2. Geben Sie am Ende der Datei unter [params] Ihre Konfiguration ein.
    Die Datei enthält Kommentare mit einem Beispiel für die Struktur. Die Liste sollte folgendermaßen strukturiert sein:
    [params]
      [[params.api-list]]
        "<group_1>" = [ "<api_1>", "<api_2>" ]
      [[params.api-list]]
        "<group_2>" = [ "<api_3>", "<api_4>" ]
      [[params.api-list]]
        "default" = [ "<api_5>", "<api_6>" ]
    Sie können so viele Gruppen wie erforderlich hinzufügen. Oder Sie sortieren APIs im Standardmodus "default", wenn sie am Anfang der Liste ohne spezifische Gruppe angezeigt werden sollen.

    Die APIs müssen anhand des Namens ihres Ordners in apis referenziert werden. Gruppennamen können UTF-8- und Unicode-Zeichen enthalten.

    InformationshinweisAnmerkung: Nach der Erstellung der Liste in config.toml müssen neue APIs hinzugefügt werden, damit sie im Portal angezeigt werden.
  3. Übergeben Sie Ihre Änderungen.

Ergebnisse

Sobald Ihr Portal mit dieser neuen Konfiguration implementiert wurde, werden die APIs in den angegebenen Gruppen angezeigt.
Mit der folgenden Konfiguration würde die Liste wie in der nachstehenden Abbildung angezeigt:
[params]
  [[params.api-list]]
    "Inventory" = [ "books", "dvds" ]
  [[params.api-list]]
    "Sales" = [ "customers", "orders" ]
  [[params.api-list]]
    "default" = [ "employees"]
Die Books API und die DVDs API werden unter „Inventory (Lagerbestand)“ angezeigt, die Customers API und die Orders API unter „Sales (Vertrieb)“. Die Employees API befindet sich oben auf der Seite und gehört keiner Gruppe an.

Hat diese Seite Ihnen geholfen?

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!