Authlete Library for Deno

概要

Authlete Web API のための Deno ライブラリです。

ライセンス

Apache License, Version 2.0

ソースコード

https://github.com/authlete/authlete-deno

前提条件

このライブラリを利用するためには、以下の要件が必須となります。

• Authlete にサインアップ済みであること。詳細はこちらをご覧ください。

• tsconfig.json ファイル内の experimentalDecorators オプションと emitDecoratorMetadata オプションの値を true に設定すること。

• deno run コマンド実行時に --allow-net オプションと --allow-read オプションを付与すること。

クイックスタート

Step 1: モジュールをインポート。

import { AuthleteApiFactory } from 'https://deno.land/x/authlete_deno@v1.2.2/mod.ts';

Step 2: AuthleteApi のインスタンスを初期化。

// configuration 用のオブジェクトを作成。
// 注意: 以下のクレデンシャルは自身のものに置き換えること。
const config = {
    serviceOwnerApiKey:    'YOUR_SERVICE_OWNER_API_KEY',
    serviceOwnerApiSecret: 'YOUR_SERVICE_OWNER_API_SECRET',
    serviceApiKey:         'YOUR_SERVICE_API_KEY',
    serviceApiSecret:      'YOUR_SERVICE_API_SECRET'
};

// AuthleteApi のインスタンスを作成。
const api = AuthleteApiFactory.create(config);

Step 3: AuthleteApi のメソッドを呼び出して Authlete API にアクセス。

例 1: サービス群を取得。

// サービス群を取得する。
// 以下のコードは Authlete の '/service/get/list' API をコールする。
const response: ServiceListResponse = await api.getServiceList();

// 各サービスの情報を出力。
for (const service of response.services)
{
    console.log(service);
}

例 2: クライアントアプリケーションを新規作成。

// Client オブジェクトを新規作成。
const request = new Client();

// いくつかのプロパティを設定。
request.clientName  = 'My Client';
request.description = 'This is my client.';

// 新規クライアントアプリケーションを Authlete 上に登録。
// 以下のコードは Authlete の '/client/create' API をコールする。
const response: Client = await api.createClient(request);

// 作成したクライアントアプリケーションの情報を出力。
console.log(response);

説明

AuthleteApi の取得方法

Authlete Web API とやりとりするメソッドは全て AuthleteApi インターフェースに集められています。AuthleteApi インターフェースの実装クラスとして、 このライブラリは AuthleteApiImpl クラスを提供しています。 AuthleteApiImpl クラスのインスタンスを取得する方法は以下のようになります。

方法 1: AuthleteApiImpl クラスのコンストラクターを利用する。

// configuration 用のオブジェクトを作成。
const config: AuthleteConfiguration = { ... };

// AuthleteApiImpl クラスのインスタンスを作成。
const api: AuthleteApi = new AuthleteApiImpl(config);

方法 2: AuthleteApiFactory クラスの create() メソッドを利用する。

// configuration 用のオブジェクトを作成。
const config: AuthleteConfiguration = { ... };

// AuthleteApiImpl クラスのインスタンスを作成。
const api = await AuthleteApiFactory.create(config);

方法 3: AuthleteApiFactory クラスの getDefault() メソッドを利用する。

// AuthleteApiImpl クラスのデフォルトインスタンスを取得。
const api = await AuthleteApiFactory.getDefault();

注意: AuthleteApiFactory クラスの getDefault() メソッドが初めて呼び出されると、 実行ディレクトリ直下にある設定ファイル (authlete.json) がロードされ、その設定内容を用いて AuthleteApiImpl クラスがインスタンス化されます。作成されたインスタンスは AuthleteApiFactory クラス内にキャッシュされるため、当該メソッドに対する以降のメソッドコールは、 そのキャッシュを返却するのみとなります。

AuthleteConfiguration

AuthleteApi インスタンスの設定を行うには、主に二つの方法があります。

方法 1: AuthleteConfiguration インターフェースを利用する。

// configuration 用のオブジェクトを作成。
const config: AuthleteConfiguration = {
    baseUrl:               '...',
    serviceOwnerApiKey:    '...',
    serviceOwnerApiSecret: '...',
    serviceApiKey:         '...',
    serviceApiSecret:      '...'
};

// AuthleteApi のインスタンスを作成。
const api = await AuthleteApiFactory.create(config);

方法 2: AuthletePropertyConfiguration クラスを利用する。

外部ファイルを用いて設定を行いたい場合は、AuthleteConfiguration インターフェースの実装クラスである AuthletePropertyConfiguration クラスを利用してください。このクラスの create() メソッドは、実行ディレクトリ直下にある設定ファイル (authlete.json) をロードし、その内容に基づいて configuration 用のオブジェクトを作成します。 以下のその例です。

// 'authlete.json' をロードして、configuration 用のオブジェクトを作成。
const config = await AuthletePropertyConfiguration.create();

// AuthleteApi のインスタンスを作成。
const api = await AuthleteApiFactory.create(config);

設定ファイル (authlete.json) 内で有効なプロパティーキーとその意味は次のとおりです。

AuthleteApi メソッドのカテゴリー

AuthleteApi インターフェースのメソッド群は幾つかのカテゴリーに分けることができます。

1. 認可エンドポイント実装のためのメソッド群

• authorization(AuthorizationRequest request)
• authorizationFail(AuthorizationFailRequest request)
• authorizationIssue(AuthorizationIssueRequest request)

1. トークンエンドポイント実装のためのメソッド群

• token(TokenRequest request)
• tokenFail(TokenFailRequest request)
• tokenIssue(TokenIssueRequest request)

1. サービス管理のためのメソッド群

• createService(service: Service)
• deleteService(serviceApiKey: number)
• getService(serviceApiKey: number)
• getServiceList(start?: number, end?: number)
• updateService(service: Service)

1. クライアントアプリケーション管理のためのメソッド群

• createClient(client: Client)
• deleteClient(clientId: number)
• getClient(clientId: number)
• getClientList(developer?: string, start?: number, end?: number)
• updateClient(client: Client)

1. アクセストークンの情報取得のためのメソッド群

• introspection(request: IntrospectionRequest)
• standardIntrospection(request: StandardIntrospectionRequest)

1. アクセストークン取り消しエンドポイント実装のためのメソッド群

• revocation(request: RevocationRequest)

1. ユーザー情報エンドポイント実装のためのメソッド群

• userInfo(request: UserInfoRequest)
• userInfoIssue(request: UserInfoIssueRequest)

1. JWK セットエンドポイント実装のためのメソッド群

• getServiceJwks(pretty: boolean, includePrivateKeys: boolean)

1. OpenID Connect Discovery のためのメソッド群

• getServiceConfiguration(pretty: boolean)

リリース手順

1. ドキュメント更新

README.md と README.md.ja、CHANGE.md と CHANGE.md.ja を適宜更新します。

2. ライブラリ公開

Github のリリースページ 上で新しいバージョンのライブラリを リリースします。（Github のリリース機能の詳細については、こちらのページ ご覧ください。）

Github 上でリリースを行うことにより webhook がトリガーされ、自動的に新規バージョンのライブラリが deno.land/x へと公開されます。

その他の情報

• Authlete - Authlete ホームページ
• deno-fen-oauth-server - 認可サーバー実装
• deno-fen-resource-server - リソースサーバー実装

コンタクト