Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Erstellen einer neuen Seite

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

Prozedur

  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:
Screenshot der neuen Seite „Examples (Beispiele)“ im Portal.

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!