CData Software Blog

クラウド連携のCData Software の技術ブログです。

API自動生成ツール CData API Server が日本語カラム名の自動設定に対応

f:id:sugimomoto:20210317091241p:plain

こんにちは。CData Software Japanリードエンジニアの杉本です。

CData では RDBや各種CSVExcelファイルなどからAPIを自動生成するAPI Serverという製品を扱っています。

www.cdata.com

kageura.hatenadiary.jp

このAPI Server の最新バージョンでは、プロパティを簡単に日本語で利用することができるようになりました!

f:id:sugimomoto:20210316221537p:plain

今回はその使い方を簡単に紹介していきたいと思います!

以前のバージョンでの挙動

まずはじめに以前のバージョンまでの挙動について確認しておきましょう。

例えば、SQL ServerMySQLのようなRDBでは以下のように日本語のカラム名を使って、テーブルを構成することができると思います。

f:id:sugimomoto:20210316221545p:plain

このテーブルを API Server で定義しようとすると、Unicodeベースの変換が行われてしまい、以下のようにほぼ文字化けのような状態となってしまっていました。

f:id:sugimomoto:20210316221602p:plain

APIのレスポンスも以下のようになってしまい、何がなんだかわからない状態でした。

f:id:sugimomoto:20210316221609p:plain

ただ、回避策は存在し、一応以下のようにエイリアスを設定することができます。でも、一つ一つ訂正するのはちょっと億劫ですね。

f:id:sugimomoto:20210316221617p:plain

最新バージョンでの挙動

これが最新バージョンでは、以下のように日本語のエイリアス名がデフォルトで生成され指定されるようになりました!

f:id:sugimomoto:20210316221622p:plain

APIのレスポンスを見てもこのとおり。

f:id:sugimomoto:20210316221628p:plain

API Server では様々なクエリパラメータに対応していますが、同じように扱うことができます。

http://localhost:8153/api.rsc/Customers/?$select=顧客名,メールアドレス&$filter=メールアドレス eq 'mori_jun@example.com'

f:id:sugimomoto:20210316221634p:plain

リソース名について

なお、リソース名は自動生成には対応していませんが、手動で日本語に設定することは可能です。

f:id:sugimomoto:20210316221641p:plain

API ドキュメントでは、URLエンコードされた値となってしまいますが

f:id:sugimomoto:20210316221650p:plain

ブラウザでアクセスしてみると、ちゃんと日本語で表示されます。

f:id:sugimomoto:20210316221657p:plain

おわりに

ちなみに、この最新ビルドは3月時点でまだWebサイトで入手することができないため、利用したい場合はテクニカルサポートまでご連絡をください。

https://www.cdata.com/jp/support/submit.aspx

技術的なご質問なども合わせてお気軽にどうぞ!