コンテンツを整理および追加

ランディングページを設定し、カスタムコンテンツを表示します。

1. API Portalリポジトリーで、/content/_index.mdというランディングページファイルを開きます。
2. api-listパラメーターの値をfalseに変更します。

   

3. 終了の---の下に、ランディングページに表示したいコンテンツを入力します。
   必要であればタイトルを編集することもできます。
4. 変更をコミットします。

ポータルを設定して、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文字を含めることができます。

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

Results

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

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

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

ポータルにMarkdownファイルを新しいページとして追加します。

1. API Portalリポジトリーで、contentフォルダーに移動します。
2. 新しいMarkdownファイルを作成します。
   ファイル名はページのURLを作成するために使用されます。examples.mdという名前のファイルを作成すると、ページは<portal-url>/examplesで利用できるようになります。
3. ページのメタデータを追加
   メタデータは---で囲まれており、ページのタイトルとヘッダー上でのその位置を定義します。ヘッダーには最低から最高までのweightのページが表示されます。weightの等しいページが複数ある場合は、アルファベット順にソートされます。デフォルトでは、"はじめに"ページのweightは10に、"APIs"ページは20に設定されています。weight: 20で"Examples"という名前の新しいページを追加すると、ヘッダー内で"APIs"の後ろに表示されます。

   例

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

4. コンテンツをメタデータの下に追加します。
   Markdownへの書き込みについては、Markdown Guideをご覧ください。

   例

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

   情報メモTip: コンテンツにコードサンプルを追加する場合は、```を開いた後に言語を指定して、構文の強調表示を有効にすることができます。
5. 変更をコミットします。

Results

ポータルをデプロイすると新しいページが表示されます。この例では次のようになります。