起動パラメータ

• pushheadersの使い方
  　SPAページダウンロードやAPIレスポンスのHTTPヘッダに以下のような指定で任意のヘッダ値を挿入できます。

boot-params
   +pushheaders.Access-Control-Allow-Origin=https://hogeohge.axis-dev.io
   +pushheaders.Access-Control-Allow-Credentials=true

• configsプロパティで、環境依存データを管理して、SPAから動的にAPIから処理させることができます。例えばSPAのプルダウンの候補値を環境毎に変えたい場合などは、SPA側で持つのではなくconfigsプロパティで管理しておき、SPAからAPI参照で取得させることで、環境依存データの分離が可能になり環境毎にSPAのビルドを行う必要がなくなります。

boot-params
   +configs="{\"enum_data\":[\"dev-001\",\"dev-002\"]}"

指定したビルドコマンドにて、ApiFrontの起動時にSPAのビルドが行われます。また、watch.pathを指定した場合、ディレクトリ配下のファイルに変更があった際にもビルドが行われます。ビルド中は一時的にファイルアクセスができなくなる場合があるため、商用環境ではこの機能は利用せず、ビルド済みSPAを利用するようにしてください。

boot-params
   +content.build.cwd="/var/plugins/xxx_gui/client"
   +content.build.command="npm ci --legacy-peer-deps&&npm run build"
   +content.build.watch.path="./src"
   +content.build.watch.pattern="/**/*.js"

build機能を用いてnpm config setを実行し、.npmrcファイルを更新することでprivate packageへの認証を設定することが可能です。
下記はGitHubで準備したprivate packageを使用した例になります。

boot-params
   +content.build.cwd="/var/plugins/xxx_gui/client"
   +content.build.command="\"npm config set //npm.pkg.github.com/:_authToken=********** &&  npm config set @{workspace}:registry=\"https://npm.pkg.github.com\" && npm ci --legacy-peer-deps && npm run build\""

content.snippets の指定は、content.snipets と記載しても動作します

• SDKポータル連携の場合の設定例

boot-params
+authentication.strategy=qmonus
+authentication.generator=qmonus
+authentication.options.base_url=https://XXXXX
+authentication.options.pass_code=**************************
+authentication.options.pass_phrase=*************
+authentication.options.enableSLO=true

• Google連携の場合の設定例

boot-params
+authentication.strategy=google
+authentication.options.project_id=**********
+authentication.options.client_id=**********
+authentication.options.client_secret=**********
+authentication.options.callbackProto=https

[参考] GCPのOAuthクライアントの設定でコールバックURLを指定する際には、https://XXXXX/auth/google/callback のようにパスを含めて指定してください。

• OpenID連携の場合の設定例

boot-params
+authentication.strategy=openid
+authentication.options.providerURL=**********
+authentication.options.profile=true
+authentication.options.discover.match=**********
+authentication.options.discover.version="http://specs.openid.net/auth/2.0"
+authentication.options.discover.endpoint=**********

[参考] OpenIDのOAuthクライアントの設定でコールバックURLを指定する際には、https://XXXXX/auth/openid/callback のようにパスを含めて指定してください。

• 認証シーケンスでのユーザ情報取得やトークン生成ロジックは、カスタマイズも可能です。

boot-params
+authentication.strategy=openid
+authentication.options.providerURL=**********

+authentication.provider_plugin="/Desktop/plugin/auth.js"
+authentication.generator_plugin="/Desktop/plugin/token.js"
+authentication.properties.hoge_user="user"
+authentication.properties.fuga_user_endpoint="pass"
+authentication.properties.fuga_token_endpoint="pass"

auth.js

javascript
module.exports = function (bootProperties) {

	// bootProperties で 起動パラメータの authentication.properties が参照可能

	/**
	 * context    : { store , option , properties , calloutHelper }
	 * identifier : strategy で指定したプロトコルで参照できるユーザ識別情報
	 * callback   : コールバック関数 ( err , profile)
	 */
	return (context, [identifier], callback) => {

		context.calloutHelper({
			method: "GET",
			url: bootProperties.fuga_endpoint + "/api/users/" + identifier,
		})
		.catch(callback)
		.then(({ response, body }) => {

			let profile = {
				account_id: identifier,         // ユーザ識別子
                account_name : body.username,
				email: body.mail_address,
				avatar: body.avatar_url,

				// _ から始まるキーワードは、hiddenプロパティとして /session の応答からは参照できない
				_properties: body
			}
			callback(null, profile)
		})
	}
}

token.js

javascript
module.exports = function ( bootProperties){

    // bootProperties で 起動パラメータの authentication.properties が参照可能

    /**
     * context    : { _req , profile , store ,  properties , config , calloutHelper }
     * callback   : コールバック関数 ( err , profile)
     */
    return ( context , callback )=>{

        context.calloutHelper({
            method : "POST",
            url: bootProperties.fuga_token_endpoint + "/api/tokens",
        })
        .catch(callback)
        .then({ response, body }=>{
            let token = response.headers["token"]
            body = JSON.parse(body)
                
            callback(null , {
                token : token ,             // 保持するToken情報
                expires : body.expires_at , // 有効期限がある場合
            })
        })
    }
}

API Proxy機能は、コンテンツタイプが json のリクエストに対して動作します。Proxy機能が動作しない場合は、リクエストヘッダーのAcceptの値を確認し、MIMEタイプにJSONが含まれているか確認してください。

 Accept : */* ,application/json

• 以下のような設定を行った場合

boot-params
+backend.proxypath=/apis
+backend.target=https://backend.api.server

API-Proxyでは、/apis 以下のAPIアクセスに対して、以下のようなHTTPプロキシーを行います
/apis/v1/hogefuga => https://backend.api.server/v1/hogefuga

boot-params
+backend.proxypath=/v1
+backend.target=https://backend.api.server/v1