このガイドでは、saasus-sdk-csharp を .NET 8 および .NET Framework 4.8 アプリケーションに導入する手順を説明します。
-
ソリューションに SDK を追加
- Visual Studio で ソリューション (.sln) を開く
- ソリューションエクスプローラー でアプリケーションプロジェクトを右クリックし、[参照の追加] を選択
- [プロジェクト] タブから
saasus-sdk-csharpを選択し、[OK] をクリック
-
ビルド
- メニューから [ビルド] → [ソリューションのビルド] を選択
- ビルドが完了し、エラーがないことを確認
-
実行
- F5 キー または [デバッグ] → [デバッグの開始] でアプリケーションを実行
- Ctrl + F5 または [デバッグなしで開始] でデバッグなし実行
-
アプリケーションプロジェクトのディレクトリに移動(
MyAppがアプリケーションプロジェクトのフォルダと仮定)cd path/to/MyApp -
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への相対パスです。
ユーザーのプロジェクト構成によって適宜パスを変更してください。 - アプリケーションプロジェクトの
-
ビルド & 実行(アプリケーションプロジェクトのディレクトリまたはソリューションのディレクトリで実行)
dotnet build dotnet run
アプリケーションコード内で saasus-sdk-csharp を参照し、期待する機能が正しく動作するか確認してください。
SDKではデフォルトでNewtonsoft.Jsonライブラリを使用しています。そのため、アプリケーションのJSONライブラリがSystem.Text.Jsonなど他のライブラリに設定されている場合、以下の点に注意が必要です。
モデルをそのままレスポンスとして返却できます。
var userInfo = await userInfoApi.GetUserInfoAsync(token);
// モデルをそのままレスポンスに返却
return Ok(userInfo);シリアライズ処理を明示的に行う必要があります。
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ライブラリの設定に応じて、必要なシリアライズ処理を追加してください。
-
SDK のソースコードがあるディレクトリに移動します:
cd <SDKのソースコードディレクトリ>
-
以下のコマンドを実行してプロジェクトをビルドします:
dotnet build -c Release
-
ビルドが成功したことを確認してください。
-
以下のコマンドを実行して NuGet パッケージを生成します:
dotnet pack -c Release
-
コマンドを実行すると、
bin/Releaseフォルダに.nupkgファイルが生成されます。 例:bin/Release/saasus-sdk-csharp.1.0.0.nupkg
ローカルフィードとして利用するディレクトリを作成します:
mkdir C:\LocalNuGetFeed生成した .nupkg ファイルをローカルフィードディレクトリにコピーします:
cp bin/Release/saasus-sdk-csharp.1.0.0.nupkg C:\LocalNuGetFeed- Visual Studio を開きます。
- メニューから [ツール] → [オプション] を選択します。
- [NuGet パッケージ マネージャー] → [パッケージ ソース] を選択します。
- [追加] ボタンをクリックし、以下を設定します:
- 名前: LocalFeed(任意の名前)
- ソース:
C:\LocalNuGetFeed
- [OK] をクリックして保存します。
-
対象プロジェクトを開く
- Visual Studio で
.NET Frameworkプロジェクト(例:MyApp.sln)を開きます。
- Visual Studio で
-
NuGet パッケージをインストール
- ソリューションエクスプローラーでプロジェクトを右クリックし、[NuGet パッケージの管理] を選択します。
- 「パッケージソース」から、追加した
LocalFeedを選択します。 - 一覧に表示された
saasus-sdk-csharpを選択し、[インストール] をクリックします。
SDKを正しく動作させるには、以下の環境変数の設定が必要です。
| 環境変数名 | 説明 |
|---|---|
SAASUS_SAAS_ID |
SaaSの識別子(SaaS ID) |
SAASUS_API_KEY |
APIアクセス用のAPIキー |
SAASUS_SECRET_KEY |
クライアントシークレットキー |
環境変数の設定方法は、実行環境やアプリケーションの要件に応じて適切に行ってください。
例えば、appsettings.jsonに定義した値を読み込んで環境変数に設定することもできます。