メイン コンテンツをスキップする 補完的コンテンツへスキップ

GitHubを使ってポータルを設定

Talend Cloud API Designerでは、GitHubリポジトリーを自動的に設定し、API Portalの設定を入力して、APIドキュメンテーションを含めることができます。 異なるソースコントロールプロバイダーを使用する場合は、別のGitプロバイダーでポータルを設定をご覧ください。

手順

  1. Talend Cloud API Designerを開き、API Portalタブに移動します。
  2. [Configure the API Portal] (API Portalを設定)をクリックします。
  3. GitHubリポジトリーを接続します。
    • GitHubアカウントをTalend Cloud API Designerにまだリンクしていない場合は、[Link your GitHub account] (GitHubアカウントをリンク)をクリックして、Talendにリポジトリーへのアクセスを許可します。
    • アカウントがリンク済みの場合は、[Select a GitHub repository] (GitHubリポジトリーを選択)をクリックします。
    API Portal設定ページ。
  4. 使用するリポジトリーを選択します。
    • 新しいリポジトリーを作成するには、[Create a new GitHub repository] (新しいGitHubリポジトリーを作成)を選択し、オーナーを選択して名前を入力します。
    • 既存のリポジトリーを使用するには、[Use an existing GitHub repository] (既存のGitHubリポジトリーを使用)を選択し、所有者、リポジトリー、および使用するブランチを選択します。
    [GitHubリポジトリーを選択]ダイアログボックス。
  5. オプション: GitHub Pagesにポータルを自動で公開したい場合は、[Enable GitHub Pages] (GitHub Pagesを有効化)ボタンをクリックし、GitHubワークフロー権限を付与します。
    リポジトリーでGitHub Actionsを自動で設定するには、この権限が必要です。後で、API Portal設定からまたは、手動でリポジトリーからGitHub Pagesを有効化できます。詳細は、GitHub Pagesでポータルをデプロイをご覧ください。
    情報メモ注: これはリポジトリーに存在するどのGitHub Pages設定も上書きします。
  6. [Select API Documentation to publish] (公開するAPIドキュメンテーションを選択)をクリックします。
    既存のリポジトリーを使用した場合は選択したブランチ上、またはリポジトリーを新規に作成した場合はmainブランチ上の選択したリポジトリーにAPI Portalテンプレートがコミットされます。公開可能なAPIのリストが表示されます。
  7. 公開するAPIの横にある[Publish] (公開)ボタンをクリックします。
    公開されていないAPIのリストのスクリーンショット。

タスクの結果

API Portal リポジトリーが設定され、自身の最初のAPIが公開されます。これで、ポータルをカスタマイズしてデプロイすることができます。

このページは役に立ちましたか?

このページまたはコンテンツに、タイポ、ステップの省略、技術的エラーなどの問題が見つかった場合は、お知らせください。改善に役立たせていただきます。