Skip to content

APIキーについて

Yamato edited this page Dec 5, 2022 · 4 revisions

RESAS APIの登録

RESAS APIを使うには登録が必要。

https://opendata.resas-portal.go.jp/

登録するとAPIキーが発行され、ログイン後の画面で確認できる。

APIキーの利用方法について

ローカル上での設定

参考:Viteの中で環境変数の使用

1. env.localを作成し、APIキーを記述する。

ルート直下に.env.localファイルを作成。 ファイル内に以下の記述を追記して保存する。

必ずプレフィックスとして VITE_ が必要。

VITE_RESAS_API_KEY="APIキー文字列"

2. JSファイルでの使用

import.meta.env で環境変数を読み込んで使用する。

const apiKey = import.meta.env.VITE_RESAS_API_KEY;

デプロイ時

このリポジトリのSecretsにVITE_RESAS_API_KEYの環境変数を登録している(Settings → Secrets → Actions)
デプロイ時にGitHub Actionsの設定でSecretsを読み込み、その値を.envに追記して使用している。

- name: Build
  env:
    VITE_RESAS_API_KEY: ${{ secrets.VITE_RESAS_API_KEY }}
  run: npm run build

env.localについて

env.localはコミット対象外の環境変数用ファイルで、ローカル上でのみ保持する。