Organisieren und Hinzufügen von Inhalten

Konfigurieren Sie die Landingpage, d. h. die Einstiegs- oder Zielseite, für die Anzeige von benutzerspezifischem Inhalt.

1. Öffnen Sie im Repository Ihres API-Portals die Landingpage-Seite: /content/_index.md.
2. Ändern Sie den Wert des Parameters api-list zu false.

   

3. Geben Sie unter dem Endzeichen --- den Inhalt ein, der auf der Landingpage angezeigt werden soll.
   Nach Bedarf können Sie auch den Titel bearbeiten.
4. Übergeben Sie Ihre Änderungen.

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

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"]

Fügen Sie eine Markdown-Seite als neue Seite in Ihrem Portal hinzu.

1. Navigieren Sie in Ihrem API-Portal-Repository zum Ordner content.
2. Erstellen Sie eine neue Markdown-Datei.
   Der Name der Datei wird zur Erstellung der URL der Seite verwendet. Wenn Sie eine Datei namens examples.md erstellen, steht die Seite unter <portal-url>/examples zur Verfügung.
3. Fügen Sie Metadaten für Ihre Seite hinzu.
   Die Metadaten werden von den Zeichen --- eingegrenzt und definieren den Titel der Seite und deren Position im Header. Der Header zeigt die Seiten von der niedrigsten zur höchsten Gewichtung (weight) an. Wenn zwei Seiten über dieselbe Gewichtung (weight) verfügen, werden sie in alphabetischer Reihenfolge angeordnet. Die Seite „Erste Schritte“ erhält standardmäßig die Gewichtung (weight) 10, die Seite „APIs“ die Gewichtung 20. Wenn Sie beispielsweise eine neue Seite namens „Examples“ (Beispiele) mit der Gewichtung 20 (weight: 20) hinzufügen, wird sie nach „APIs“ im Header angezeigt.

   Example

   ---
   title: Examples
   menu:
     main:
       weight: 20
   ---

4. Fügen Sie Ihren Inhalt unter den Metadaten hinzu.
   Weitere Informationen zum Schreiben in der Markdown-Sprache finden Sie im Markdown-Handbuch.

   Example

   ---
   title: Examples
   menu:
     main:
       weight: 20
   ---
   
   # Examples
   
   ## Fetching a book by title
   
   1. Generate an access token.
   2. Run the following command with the relevant query parameters:
     `curl -X GET -H "Authorization:Basic {userToken}" https://company.com/api/books?title={bookTitle}`
   
   ### Result
   A response containing information about the book is returned. For example, the request `https://company.com/api/books?title=Jane+Eyre` returns the following information:
   ``` json
   [
     {
       "id": "hfp1651869",
       "title": "Jane Eyre",
       "author": "Charlotte Brontë",
       "publisher": "Penguin",
       "isbn": "978-0141441146"
     }
   ]
   ```

   InformationshinweisTipp: Wenn Sie Ihrem Inhalt Codebeispiele hinzufügen möchten, können Sie die Sprache nach den Anfangszeichen ``` angeben, um die Syntaxhervorhebung zu aktivieren.
5. Übergeben Sie Ihre Änderungen.

Ergebnisse

Nach der Implementierung des Portals wird die neue Seite angezeigt. Im vorliegenden Beispiel sieht dies folgendermaßen aus: