Dotnetnuke (DNN) でカスタム REST API エンドポイントを作成する
概要
DNN REST API プラグインを使用すると、DNN プラットフォーム内にカスタム API エンドポイントを作成し、外部システムが DNN 機能とやり取りできるようになります。すべての HTTP メソッドを使用して、特定の要件を満たすようにカスタム API エンドポイントを簡単に構成できます。このユーザー ガイドには、カスタム API の設定とテストに役立つ包括的なドキュメントが用意されています。
前提条件: ダウンロードとインストール
- DNN REST APIのカスタムAPIを構成するには、 miniOrange DNN REST API 認証プラグイン DNNストアより。
- インストールパッケージをアップロードするには、 [設定] > [拡張機能] > [拡張機能のインストール]。
構成手順
DNN カスタム API 認証のステップ バイ ステップ ガイド。
1.DNNページにモジュールを追加します
- DNNサイトの任意のページを開き（編集モード）、 モジュールを追加します。
- 検索する DNN REST API DNN REST API をクリックします。モジュールを目的のページにドラッグ アンド ドロップします。
- DNN サイトへの DNN REST API モジュールのインストールが完了しました。
2. カスタムAPIを作成する
- に移動します DNN REST API 設定タブ。 ここで、 DNN REST API 認証プラグインのダッシュボード。
- ソフトウェアの制限をクリック APIを作成する、 カスタム API の生成を開始します。
- APIの種類を選択してください カスタム API。
- 次の詳細を入力します。
- API名: API に一意の名前を付けます。
- API メソッド: 選択 HTTPリクエストメソッド をドロップダウンから選択します。
- テーブル名： アクセスするテーブルを指定します。
- 回答欄: 操作を実行する列を選択します。
- 認証を構成する（オプション）: [詳細設定] タブには、API キー、基本認証、JWT などを含む API の認証方法を選択するオプションがあり、それぞれの方法用に作成された認証アプリをマップします。
- フィルターを適用する（オプション）: 列に条件を適用して、適用されたフィルターに基づいて特定のレコードにアクセスすることができます。
これを設定するには、条件列ドロップダウンから列を選択し、条件を適用する条件と URL パラメータを選択します。
- ソフトウェアの制限をクリック API を生成します。
- 今すぐ カスタムAPI セクションでは、作成した API を見つけることができます。
3. 生成されたAPIをテストする
- APIをテストするには、 ホイール試乗 オプションの下に 行動 ドロップダウン。
- 設定されたHTTPメソッドを持つAPIエンドポイントを含むテストポップアップが表示されます。必要に応じて、ヘッダーにパラメータを渡すか、本文にデータを渡すオプションがあります。次に、 実行します。
- すべてが正しく構成されている場合は、API が期待どおりに動作していることが確認される成功応答が表示されます。
- テストポップアップウィンドウから、API リクエストのサンプルリクエストおよびレスポンス形式を参照できます。
このガイドでは、DNNサイト用のカスタムREST APIの設定と作成方法を説明します。DNN REST APIプラグインを利用することで、DNN REST APIを安全に設定、テスト、管理できます。
