APIリストを整理

ポータルを設定して、APIのリストを表示する方法を定義します。

1. API Portalリポジトリーでconfig.tomlファイルを開きます。
2. ファイル末尾のparamsの下に設定を入力します。
   ファイルには構造の例とともにコメントが含まれています。リストは次のように構造化する必要があります。

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

   必要に応じてグループをいくつでも追加できます。また、"default"でAPIをソートし、特定のグループなしでリストの先頭に表示されるようにできます。

   APIはapis内のフォルダーの名前を使用して参照されるようにすべきです。グループ名にはUTF-8文字とUnicode文字を含めることができます。

   情報メモ注: リストがconfig.toml内に作成されたら、ポータルに表示されるよう新しいAPIを追加する必要があります。
3. 変更をコミットします。

タスクの結果

ポータルがこの新しい設定でデプロイされたら、指定したグループにAPIが表示されます。

次の設定では、リストは下図のように表示されます。

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