data-platform-api-brand-doc-reads-rmq-kube は、周辺システム を データ連携基盤 と統合することを目的に、API でブランド文書データを取得するマイクロサービスです。
https://xxx.xxx.io/api/API_BRAND_DOC_SRV/reads/
data-platform-api-brand-doc-reads-rmq-kube の動作環境は、次の通りです。
・ OS: LinuxOS (必須)
・ CPU: ARM/AMD/Intel(いずれか必須)
data-platform-api-brand-doc-reads-rmq-kube が対応する APIサービス は、次のものです。
APIサービス URL: https://xxx.xxx.io/api/API_BRAND_DOC_SRV/reads/
data-platform-api-brand-doc-reads-rmq-kube には、次の API をコールするためのリソースが含まれています。
- A_HeaderDoc(ブランド - ヘッダ文書データ)
data-platform-api-brand-doc-reads-rmq-kube において、API への値入力条件の初期値は、入力ファイルレイアウトの種別毎に、次の通りとなっています。
Latona および AION の データ連携基盤 関連リソースでは、Inputs フォルダ下の sample.json の accepter に取得したいデータの種別(=APIの種別)を入力し、指定することができます。
なお、同 accepter にAll(もしくは空白)の値を入力することで、全データ(=全APIの種別)をまとめて取得することができます。
- sample.jsonの記載例(1)
accepter において 下記の例のように、データの種別(=APIの種別)を指定します。
ここでは、"HeaderDoc" が指定されています。
"api_schema": "DPFMBrandDocReads",
"accepter": ["HeaderDoc"],
- 全データを取得する際のsample.jsonの記載例(2)
全データを取得する場合、sample.json は以下のように記載します。
"api_schema": "DPFMBrandDocReads",
"accepter": ["All"],
accepter における データ種別 の指定に基づいて DPFM_API_Caller 内の caller.go で API がコールされます。
caller.go の func() 毎 の 以下の箇所が、指定された API をコールするソースコードです。
func (c *DPFMAPICaller) AsyncReads(
accepter []string,
input *dpfm_api_input_reader.SDC,
output *dpfm_api_output_formatter.SDC,
log *logger.Logger,
) (interface{}, []error) {
mtx := sync.Mutex{}
errs := make([]error, 0, 5)
var response interface{}
// SQL処理
response = c.readSqlProcess(nil, &mtx, input, output, accepter, &errs, log)
return response, nil
}
func checkResult(msg rabbitmq.RabbitmqMessage) bool {
data := msg.Data()
d, ok := data["result"]
if !ok {
return false
}
result, ok := d.(string)
if !ok {
return false
}
return result == "success"
}
本マイクロサービスでは、golang-logging-library-for-data-platform により、以下のようなデータがJSON形式で出力されます。
以下の sample.json の例は ブランド の ヘッダ文書データ が取得された結果の JSON の例です。
以下の項目のうち、"Brand" ~ "IsMarkedForDeletion" は、/DPFM_API_Output_Formatter/type.go 内 の Type HeaderDoc {} による出力結果です。"cursor" ~ "time"は、golang-logging-library による 定型フォーマットの出力結果です。