TypeScript SDK

設定

API URLの設定、認証の設定、および内部で使用するHTTPクライアントの設定方法を説明します。

API URL

Orion.init('https://your-api.test');

APIプレフィックス

デフォルトでは、プレフィックスの値はapiに設定されていますが、場合によっては変更が必要になることもあります。

Orion.init('https://your-api.test', 'api/v1');
// または
Orion.setPrefix('api/v1');

認証ドライバー

import {AuthDriver} from '@tailflow/laravel-orion/lib/drivers/default/enums/authDriver';

Orion.init('https://your-api.test', 'api', AuthDriver.Sanctum);
// または
Orion.setAuthDriver(AuthDriver.Sanctum);

トークン

import {AuthDriver} from '@tailflow/laravel-orion/lib/drivers/default/enums/authDriver';

Orion.init('https://your-api.test', 'api', AuthDriver.Sanctum, 'test-access-token');
// または
Orion.setToken('test-access-token');

SPA向けSanctum連携

APIにリクエストを送信する前に、CSRF保護を初期化する必要があります。

import {AuthDriver} from '@tailflow/laravel-orion/lib/drivers/default/enums/authDriver';

Orion.init('https://your-api.test');
Orion.setAuthDriver(AuthDriver.Sanctum);

try {
    await Orion.csrf();
    // これで API にリクエストを送信できます
    const posts = await Post.$query().get();
} catch (error) {
    console.error('Unable to retrieve CSRF cookie.');
}

Axiosインスタンスのカスタマイズ

import axios from 'axios';

Orion.makeHttpClientUsing(() => {
  const client = axios.create();

  client.interceptors.request.use(...);

  return client;
});