top / index / prev / next / target / source

2021-05-05 diary: [Oiyokan] Getting Started Oiyokan Initializr (v0.1)

いがぴょんの日記 日記形式でつづる いがぴょんコラム ウェブページです。

[Oiyokan] Getting Started Oiyokan Initializr (v0.1)

このエントリでは Oiyokan Initializr の使い方を記述します。Oiyokan Initializr Release 0.1 (2021-05-11)をもとに記載します。 なお、本記載は、読者がある程度 Spring Boot および Web、REST/JSON、JDBC、そしてセキュリティ観点 に慣れていることを前提としています。

Oiyokan を利用すると手元の RDB を OData 4.0 Server 規約に則った REST/JSON サーバとして公開することができます。そのようなサーバを素早く構築するためのツールが Oiyokan Initializr です。

より新しいバージョンが存在します

Oiyokan Initializr にはより新しいバージョンが存在します。詳しくは 2021-05-11 diary: [Oiyokan] Getting Started Oiyokan Initializr (v0.5) を参照ください。

oiyokan-initializr を実行

  1. github.com から oiyokan-initializr project を git clone します。
git clone https://github.com/igapyon/oiyokan-initializr.git

01

  1. Maven コマンドを使って oiyokan-initializr をビルドおよび実行します。

clone されたディレクトリにディレクトリを移動して、以下の mvn コマンドを実行します。

02

mvn install spring-boot:run

03

oiyokan-initializr を使って OData Server の Spring Boot プロジェクトを作成

  1. 起動後の oiyokan-initializr に Web ブラウザで接続します。
http://localhost:8080/

04

  1. Oiyokan Initializr をクリックします。

  2. データベース設定項目を埋めます。

05

  1. Connection Test ボタンをクリックして設定の正しさを確認します。

  2. Select Table ボタンをクリックして次ページに画面移動します。

  3. 公開したいテーブルを選択してチェックします。

06

  1. GENERATE ボタンをクリックすると、oiyokan-demo.zip という名前の ZIP ファイルをダウンロードできます。

07

08

  1. Oiyokan Initializr を終了します。

11

Run Generated the OData Server

  1. どこか都合の良いディレクトリで oiyokan-demo.zip を zip展開します。

09

10

  1. zip 展開後のフォルダで以下コマンドにて oiyokan-demo を起動します

12

mvn install spring-boot:run

13

  1. 起動後の oiyokan-demo に Web ブラウザで接続します。
http://localhost:8080/

14

ここで起動されているサーバが OData v4 Server (provider) の機能を提供します。

13-1. OData v4 Server ルートを開くと、OData として接続可能な EntitySet の一覧を確認できます。

15

13-2. OData v4 Server の $metadata を開くと、EntityType の詳細を確認することができます。

16

13-3. OData 4.0 で定められた REST/JSON の規約に従い、データの検索、絞り込み、並び替えなどを実現できます。

17

  1. OData v4 Server の試行が終わったら、oiyokan-demo を終了します。

  2. 試行が終わり次第、oiyokan-demo.zip および展開後のファイル oiyokan-settings.json を削除します。

以上が Oiyokan Initializr の簡易な説明です。

関連する日記

Last modified: $Date: 2021-05-05 $

登場キーワード

この日記について