Organiser le contenu et en ajouter

Configurez votre page d'accueil pour afficher du contenu personnalisé.

1. Dans le dépôt de votre API Portal, ouvrez le fichier de la page d'accueil : /content/_index.md.
2. Modifiez la valeur du paramètre api-list à false.

   

3. Sous le --- de fermeture, saisissez le contenu à afficher sur la page d'accueil.
   Vous pouvez également modifier le titre, si nécessaire.
4. Effectuez un commit de vos modifications.

Configurez votre portail pour définir la manière d'afficher votre liste d'API.

1. Dans le dépôt de votre API Portal, ouvrez le fichier config.toml.
2. Saisissez votre configuration à la fin du fichier, sous [params].
   Le fichier contient des commentaires et un exemple de structure. La liste doit être structurée comme suit :

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

   Vous pouvez ajouter autant de groupes que vous le souhaitez. Vous pouvez trier vos API dans "default" si elles doivent s'afficher en haut de la liste, sans groupe spécifique.

   Les API doivent être référencées à l'aide du nom de leur dossier dans apis. Les noms de groupes peuvent contenir des caractères UTF-8 et Unicode.

   Note InformationsRemarque : Une fois la liste créée dans config.toml, les nouvelles API doivent y être ajoutées pour s'afficher dans le portail.
3. Effectuez un commit de vos modifications.

Résultats

Une fois votre portail déployé avec cette nouvelle configuration, vos API s'affichent dans les groupes spécifiés.

Avec la configuration suivante, la liste s'affiche comme dans l'image ci-dessous :

[params]
  [[params.api-list]]
    "Inventory" = [ "books", "dvds" ]
  [[params.api-list]]
    "Sales" = [ "customers", "orders" ]
  [[params.api-list]]
    "default" = [ "employees"]

Ajoutez un fichier Markdown en tant que nouvelle page dans votre portail.

1. Dans le dépôt de votre API Portal, allez dans le dossier content.
2. Créez un fichier Markdown.
   Le nom du fichier est utilisé pour créer l'URL de la page. Si vous créez un fichier nommé examples.md, la page sera disponible à l'adresse <portal-url>/examples.
3. Ajouter des métadonnées à votre page
   Les métadonnées sont entourées de --- et définissent le titre de la page, ainsi que sa position dans l'en-tête. L'en-tête affiche les pages, dans l'ordre croissant de poids (weight). Si deux pages ont le même poids (weight), elles sont triées par ordre alphabétique. Par défaut, le poids (weight) de la page "Getting started" est configuré à 10. Celui de la page "APIs" est configuré à 20. Si vous ajoutez une page nommée "Examples" avec weight: 20, elle s'affiche après "APIs" dans l'en-tête.

   Exemple

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

4. Ajoutez votre contenu sous les métadonnées.
   Pour plus d'informations concernant l'écriture en Markdown, consultez Markdown Guide (en anglais).

   Exemple

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

   Note InformationsConseil : Si vous souhaitez ajouter des exemples de code dans votre contenu, vous pouvez spécifier le langage après les caractères d'ouverture ``` pour activer la coloration syntaxique.
5. Effectuez un commit de vos modifications.

Résultats

Une fois votre portail déployé, la nouvelle page s'affiche. Dans cet exemple, elle a l'aspect suivant :