Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2023-01-18. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせく� さい

GitHub REST API のクイックスタート

GitHub REST API の使用を開始する方法について説明します。

この記事では、GitHub CLI、JavaScript、または cURL を使用して、GitHub REST API の使用をすばやく開始する方法について説明します。 詳しいガイドについては、「REST API を使用した作業の開始」をご覧く� さい。

GitHub CLI を使用した作業の開始

コマンド ラインでの GitHub CLI の使用

GitHub CLI は、コマンド ラインから GitHub REST API を使用する方法として最も簡単です。

  1. GitHub CLI をま� インストールしていない� �合は、インストールしてく� さい。 インストールの手� �については、GitHub CLI リポジトリを参照してく� さい。

  2. auth login サブコマンドを使用して、GitHub CLI に対する認証を行います。 詳しくは、GitHub CLIauth login のドキュメントを参照してく� さい。

    gh auth login
  3. api サブコマンドを使用して API 要求を行います。 詳しくは、GitHub CLIapi のドキュメントを参照してく� さい。

    gh api repos/octocat/Spoon-Knife/issues

GitHub Actions での GitHub CLI の使用

GitHub Actions ワークフローでは、GitHub CLI を使用することもできます。 詳しくは、「ワークフローでの GitHub CLI の使用」を参照してく� さい。

gh auth login コマンドを使用するのでなく、アクセス トークンを GH_TOKEN という環境変数として渡します。 GitHub では、トークンを作成するのでなく組み込みの GITHUB_TOKEN を使用することをお勧めしています。 これができない� �合は、ご利用のトークンをシークレットとして� �納し、次の例で GITHUB_TOKEN を実際のシークレットの名前に置き換えます。 GITHUB_TOKEN について詳しくは、「自動トークン認証」を参照してく� さい。 シークレットについて詳しくは、「暗号化されたシークレット」を参照してく� さい。

on:
  workflow_dispatch:
jobs:
  use_api:
    runs-on: ubuntu-latest
    permissions:
      issues: read
    steps:
      - env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh api repos/octocat/Spoon-Knife/issues

GitHub App を使用して認証する� �合は、ワークフロー内にインストール アクセス トークンを作成します。

  1. GitHub App の ID をシークレットとして保存します。 以下の例では、APP_ID をシークレットの名前に置き換えます。 アプリ ID は、アプリの設定ページで、あるいは API を通じて確認できます。 詳しくは、REST API のドキュメントの「アプリ」をご覧く� さい。 シークレットについて詳しくは、「暗号化されたシークレット」を参照してく� さい。
  2. アプリケーションの秘密鍵を生成してく� さい。 作成されたファイルの内容をシークレットとして保存します。 (-----BEGIN RSA PRIVATE KEY----- および -----END RSA PRIVATE KEY----- を含め、ファイルの内容全体を保存します)。以下の例では、APP_PEM をシークレットの名前に置き換えます。 詳細については、「GitHub Apps による認証」を参照してく� さい。
  3. トークンを生成するステップを追� し、GITHUB_TOKEN ではなくそのトークンを使用します。 このトークンは 60 分後に期限切れになるので注意してく� さい。 次に例を示します。
# このワークフローはGitHubによって認定されていないアクションを使用します。
# それらはサードパーティによって提供され、
# 別個の利用規約、プライバシーポリシー、
# ドキュメントを参照してく� さい。

on:
  workflow_dispatch:
jobs:
  track_pr:
    runs-on: ubuntu-latest
    steps:
      - name: Generate token
        id: generate_token
        uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0
        with:
          app_id: ${{ secrets.APP_ID }}
          private_key: ${{ secrets.APP_PEM }}

      - name: Use API
        env:
          GH_TOKEN: ${{ steps.generate_token.outputs.token }}
        run: |
          gh api repos/octocat/Spoon-Knife/issues

次の手� �

詳しいガイドについては、「REST API を使用した作業の開始」をご覧く� さい。