Organiser la liste de vos API

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