README.md

oauth-client-demo

For the English README, please refer to こちら.

このプロジェクトは、Node.jsを使用してMoney Forwardの認可サーバーとやり取りするOAuth2クライアントの実装方法を示しています。OAuth2を用いた認可、トークンの取得、トークンのリフレッシュ、保護されたリソースへのアクセスまでの一連のフローを紹介します。

前提条件

• Node.js: この例はお使いのシステムにNode.jsがインストールされていることを確認してください。Node.jsからダウンロードできます。(Node.js v22.9.0で動作確認をしています)
• OAuth2 クライアントライブラリ: OAuth2フローを正しく実装するために、@badgateway/oauth2-clientライブラリを使用します。

設定

アプリケーションを実行する前に、OAuth2のクレデンシャルとリダイレクトURIを設定する必要があります。src/index.tsのプレースホルダーを実際の値に置き換えてください。

const CLIENT_ID = 'YOUR_CLIENT_ID'; // OAuth2のクライアントIDに置き換えてください
const CLIENT_SECRET = 'YOUR_CLIENT_SECRET'; // OAuth2のクライアントシークレットに置き換えてください
const REDIRECT_URI = 'http://localhost:12345/callback'; // リダイレクトURIに置き換えてください

CLIENT_ID、CLIENT_SECRET、およびREDIRECT_URIを設定に合わせて適切に設定してください。

依存パッケージ

このプロジェクトでは以下の依存パッケージを使用しています。

• @badgateway/oauth2-client: OAuth2クライアントライブラリ
• express: ルートやHTTPリクエストを処理するWebフレームワーク

これらの依存パッケージはpackage.jsonに指定されており、以下のコマンドでインストールできます。

インストール

必要な依存パッケージをインストールするには、以下を実行してください。

npm install

ビルド

TypeScriptファイルをJavaScriptにビルドする必要があるため、以下のコマンドを実行します。

npm run build

実行

ビルド後、アプリケーションを開始するには以下を実行します。

npm start

プロジェクト構成

• src/index.ts: OAuth2クライアントの設定およびルートが定義されているメインファイル
• package.json: 依存パッケージ、スクリプト、およびその他の設定が定義されています

フォーマット

すべてのプロジェクトファイルをフォーマットするには、次のコマンドを使用します。

npm run format