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

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

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

Octokit.js の使用

Octokit.js を使用して、JavaScript スクリプト内の GitHub REST API と対話できます。 詳細については、「REST API と JavaScript を使用したスクリプト」を参照してください。

1. アクセス トークンを作成します。 たとえば、 personal access token または GitHub App ユーザー アクセス トークンを作成します。 このトークンを使用して要求を認証するため、そのエンドポイントへのアクセスに必要なスコープまたはアクセス許可を付与する必要があります。 詳細については、「REST API に対する認証 または GitHub Apps のユーザーの識別と承認を参照してください。

   警告

   アクセス トークンは、パスワードと同様に扱います。

   トークンをセキュリティで保護するために、トークンをシークレットとして格納し、 GitHub Actionsを使用してスクリプトを実行できます。 詳細については、「GitHub Actionsの Octokit.js の使用」セクションを参照してください。

   トークンを Codespaces シークレットとして格納し、 Codespacesでスクリプトを実行することもできます。 詳細については、「Codespaces の暗号化されたシークレットを管理する」を参照してください。

   これらのオプションを使用できない場合は、別の CLI サービスを使用してトークンを安全に格納することを検討してください。

2. octokitをインストールする。 たとえば、「 npm install octokit 」のように入力します。 octokit をインストールまたは読み込むための他の方法については、Octokit.js の README を参照してください。

3. スクリプトで octokit をインポートします。 たとえば、「 import { Octokit } from "octokit"; 」のように入力します。 その他の octokit のインポート方法については、Octokit.js の README を参照してください。

4. トークンを使用して Octokit のインスタンスを作成します。 YOUR-TOKEN を実際のトークンに置き換えます。

   JavaScript

   const octokit = new Octokit({ 
     auth: 'YOUR-TOKEN'
   });
   

5. octokit.request を使用して、要求を実行します。 HTTP メソッドとパスを最初の引数として送信します。 オブジェクト内のパス、クエリ、および本文のパラメーターを 2 番目の引数として指定します。 パラメーターの詳細については、「REST API を使用した作業の開始」を参照してください。

   たとえば、次の要求では、HTTP メソッドが GETされ、パスが /repos/{owner}/{repo}/issuesされ、パラメーターが owner: "octocat" され、 repo: "Spoon-Knife"されます。

   JavaScript

   await octokit.request("GET /repos/{owner}/{repo}/issues", {
     owner: "octocat",
     repo: "Spoon-Knife",
   });
   

GitHub Actions で Octokit.js を使う

GitHub Actions ワークフローで JavaScript スクリプトを実行することもできます。 詳しくは、「GitHub Actions　のワークフロー構文」をご覧ください。

アクセス トークンを使用した認証

GitHub では、トークンを作成する代わりに組み込みの GITHUB_TOKEN を使用することをお勧めします。 これができない場合は、ご利用のトークンをシークレットとして格納し、次の例で GITHUB_TOKEN を実際のシークレットの名前に置き換えます。 GITHUB_TOKEN の詳細については、「ワークフローでの認証に GITHUB_TOKEN を使用する」を参照してください。 シークレットの詳細については、「GitHub Actions でのシークレットの使用」を参照してください。

次のワークフロー例を参照してください。

1. リポジトリのコンテンツをチェックアウトする
2. Node.js を設定する
3. octokit をインストールする
4. GITHUB_TOKEN の値を、TOKEN と呼ばれる環境変数として格納し、.github/actions-scripts/use-the-api.mjs を実行する。これにより、その環境変数に process.env.TOKEN としてアクセスできます。

on:
  workflow_dispatch:
jobs:
  use_api_via_script:
    runs-on: ubuntu-latest
    permissions:
      issues: read
    steps:
      - name: Check out repo content
        uses: actions/checkout@v6

      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: '16.17.0'
          cache: npm

      - name: Install dependencies
        run: npm install octokit

      - name: Run script
        run: |
          node .github/actions-scripts/use-the-api.mjs
        env:
          TOKEN: ${{ secrets.GITHUB_TOKEN }}

ファイル パスが .github/actions-scripts/use-the-api.mjsされた JavaScript スクリプトの例を次に示します。

import { Octokit } from "octokit"

const octokit = new Octokit({ 
  auth: process.env.TOKEN
});

try {
  const result = await octokit.request("GET /repos/{owner}/{repo}/issues", {
      owner: "octocat",
      repo: "Spoon-Knife",
    });

  const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id})

  console.log(titleAndAuthor)

} catch (error) {
  console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`)
}

GitHub Appを使用した認証の実行

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

1. GitHub Appのクライアント ID を構成変数として格納します。 以下の例で、APP_CLIENT_ID を構成変数の名前に置き換えます。 クライアント ID は、アプリの設定ページまたは App API を使用して確認できます。 詳しくは、「GitHub Apps用 REST API エンドポイント」をご覧ください。 構成オプションの詳細については、「変数に情報を格納する」を参照してください。

2. アプリケーションの秘密鍵を生成してください。 作成されたファイルの内容をシークレットとして保存します。 (-----BEGIN RSA PRIVATE KEY----- および -----END RSA PRIVATE KEY----- を含め、ファイルの内容全体を保存します)。以下の例では、APP_PRIVATE_KEY をシークレットの名前に置き換えます。 詳しくは、「GitHub アプリの秘密キーの管理」をご覧ください。 シークレットの詳細については、「GitHub Actions でのシークレットの使用」を参照してください。

3. トークンを生成するステップを追加し、GITHUB_TOKEN ではなくそのトークンを使用します。 このトークンは 60 分後に期限切れになるので注意してください。 次に例を示します。

   on:
     workflow_dispatch:
   jobs:
     use_api_via_script:
       runs-on: ubuntu-latest
       steps:
         - name: Check out repo content
           uses: actions/checkout@v6
   
         - name: Setup Node
           uses: actions/setup-node@v4
           with:
             node-version: '16.17.0'
             cache: npm
   
         - name: Install dependencies
           run: npm install octokit
   
         - name: Generate token
           id: generate-token
           uses: actions/create-github-app-token@v3
           with:
             client-id: ${{ vars.APP_CLIENT_ID }}
             private-key: ${{ secrets.APP_PRIVATE_KEY }}
   
         - name: Run script
           run: |
             node .github/actions-scripts/use-the-api.mjs
           env:
             TOKEN: ${{ steps.generate-token.outputs.token }}
   
   

curl --request GET \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN"

curl --request GET \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN"

on:
  workflow_dispatch:
jobs:
  use_api:
    runs-on: ubuntu-latest
    permissions:
      issues: read
    steps:
      - env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          curl --request GET \
          --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
          --header "Accept: application/vnd.github+json" \
          --header "Authorization: Bearer $GH_TOKEN"

on:
  workflow_dispatch:
jobs:
  use_api:
    runs-on: ubuntu-latest
    permissions:
      issues: read
    steps:
      - env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          curl --request GET \
          --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
          --header "Accept: application/vnd.github+json" \
          --header "Authorization: Bearer $GH_TOKEN"