saasus-sdk-csharp 1.0.0-test.2

SDK 使用手順

このガイドでは、saasus-sdk-csharp を .NET 8 および .NET Framework 4.8 アプリケーションに導入する手順を説明します。

.NET 8 アプリケーションで SDK を使用する手順

1. SDK をプロジェクトに追加し、ビルド＆実行する

Visual Studio を使用する場合

1. ソリューションに SDK を追加

   • Visual Studio で ソリューション (.sln) を開く
   • ソリューションエクスプローラー でアプリケーションプロジェクトを右クリックし、[参照の追加] を選択
   • [プロジェクト] タブから saasus-sdk-csharp を選択し、[OK] をクリック

2. ビルド

   • メニューから [ビルド] → [ソリューションのビルド] を選択
   • ビルドが完了し、エラーがないことを確認

3. 実行

   • F5 キー または [デバッグ] → [デバッグの開始] でアプリケーションを実行
   • Ctrl + F5 または [デバッグなしで開始] でデバッグなし実行

コマンドラインを使用する場合

1. アプリケーションプロジェクトのディレクトリに移動（MyApp がアプリケーションプロジェクトのフォルダと仮定）

   cd path/to/MyApp
   

2. SDK をプロジェクト参照 & ソリューションに追加

   • アプリケーションプロジェクトの .csproj があるディレクトリで実行

   dotnet add reference ../saasus-sdk-csharp/saasus-sdk-csharp.csproj
   

   • ソリューションの .sln があるディレクトリで実行

   dotnet sln add ../saasus-sdk-csharp/saasus-sdk-csharp.csproj
   

   注意: 上記の ../saasus-sdk-csharp/saasus-sdk-csharp.csproj は、SDK の csproj への相対パスです。
   ユーザーのプロジェクト構成によって適宜パスを変更してください。

3. ビルド & 実行（アプリケーションプロジェクトのディレクトリまたはソリューションのディレクトリで実行）

   dotnet build
   dotnet run
   

3. 動作確認

アプリケーションコード内で saasus-sdk-csharp を参照し、期待する機能が正しく動作するか確認してください。

JSONライブラリについての注意点

SDKではデフォルトでNewtonsoft.Jsonライブラリを使用しています。そのため、アプリケーションのJSONライブラリがSystem.Text.Jsonなど他のライブラリに設定されている場合、以下の点に注意が必要です。

Newtonsoft.Jsonを使用する場合

モデルをそのままレスポンスとして返却できます。

var userInfo = await userInfoApi.GetUserInfoAsync(token);

// モデルをそのままレスポンスに返却
return Ok(userInfo);

異なるJSONライブラリを使用する場合

シリアライズ処理を明示的に行う必要があります。

var userInfo = await userInfoApi.GetUserInfoAsync(token);

// JSON形式でレスポンスを返す（SDKのToJsonメソッドを利用）
var jsonResponse = userInfo.ToJson();
return Results.Text(jsonResponse, "application/json");

// Newtonsoft.Jsonを使用して明示的にシリアライズ
var jsonResponse = JsonConvert.SerializeObject(users.VarUsers);
return Results.Text(jsonResponse, "application/json");

JSONライブラリの設定に応じて、必要なシリアライズ処理を追加してください。

.NET Framework 4.8（packages.config）アプリケーションで SDK を使用する手順

1. SDK プロジェクトのビルド

1. SDK のソースコードがあるディレクトリに移動します：

   cd <SDKのソースコードディレクトリ>
   

2. 以下のコマンドを実行してプロジェクトをビルドします：

   dotnet build -c Release
   

3. ビルドが成功したことを確認してください。

2. NuGet パッケージの生成

1. 以下のコマンドを実行して NuGet パッケージを生成します：

   dotnet pack -c Release
   

2. コマンドを実行すると、bin/Release フォルダに .nupkg ファイルが生成されます。 例:

   bin/Release/saasus-sdk-csharp.1.0.0.nupkg
   

3. ローカルフィードの設定

3.1 ローカルフィード用ディレクトリを作成

ローカルフィードとして利用するディレクトリを作成します：

mkdir C:\LocalNuGetFeed

3.2 パッケージをコピー

生成した .nupkg ファイルをローカルフィードディレクトリにコピーします：

cp bin/Release/saasus-sdk-csharp.1.0.0.nupkg C:\LocalNuGetFeed

3.3 Visual Studio でローカルフィードを設定

1. Visual Studio を開きます。
2. メニューから [ツール] → [オプション] を選択します。
3. [NuGet パッケージ マネージャー] → [パッケージ ソース] を選択します。
4. [追加] ボタンをクリックし、以下を設定します：
   • 名前: LocalFeed（任意の名前）
   • ソース: C:\LocalNuGetFeed
5. [OK] をクリックして保存します。

4. アプリケーションに SDK をインストール

1. 対象プロジェクトを開く

   • Visual Studio で .NET Framework プロジェクト（例: MyApp.sln）を開きます。

2. NuGet パッケージをインストール

   1. ソリューションエクスプローラーでプロジェクトを右クリックし、[NuGet パッケージの管理] を選択します。
   2. 「パッケージソース」から、追加した LocalFeed を選択します。
   3. 一覧に表示された saasus-sdk-csharp を選択し、[インストール] をクリックします。

環境変数の設定

SDKを正しく動作させるには、以下の環境変数の設定が必要です。

環境変数の設定方法は、実行環境やアプリケーションの要件に応じて適切に行ってください。 例えば、appsettings.jsonに定義した値を読み込んで環境変数に設定することもできます。