latonaio / data-platform-api-brand-doc-creates-rmq-kube

data-platform-api-brand-doc-creates-rmq-kube

data-platform-api-brand-doc-creates-rmq-kube は、周辺システム を データ連携基盤 と統合することを目的に、API でブランド文書データを登録するマイクロサービスです。

• https://xxx.xxx.io/api/API_BRAND_DOC_SRV/creates/

動作環境

data-platform-api-brand-doc-creates-rmq-kube の動作環境は、次の通りです。
・ OS: LinuxOS （必須）
・ CPU: ARM/AMD/Intel（いずれか必須）

本レポジトリ が 対応する API サービス

data-platform-api-brand-doc-creates-rmq-kube が対応する APIサービス は、次のものです。

• APIサービス URL: https://xxx.xxx.io/api/API_BRAND_DOC_SRV/creates/

本レポジトリ に 含まれる API名

data-platform-api-brand-doc-creates-rmq-kube には、次の API をコールするためのリソースが含まれています。

• A_HeaderDoc（ブランド - ヘッダ文書）

API への 値入力条件 の 初期値

data-platform-api-brand-doc-creates-rmq-kube において、API への値入力条件の初期値は、入力ファイルレイアウトの種別毎に、次の通りとなっています。

データ連携基盤のAPIの選択的コール

Latona および AION の データ連携基盤 関連リソースでは、Inputs フォルダ下の sample.json の accepter に登録したいデータの種別（＝APIの種別）を入力し、指定することができます。
なお、同 accepter にAll(もしくは空白)の値を入力することで、全データ（＝全APIの種別）をまとめて登録することができます。

• sample.jsonの記載例(1)

accepter において 下記の例のように、データの種別（＝APIの種別）を指定します。
ここでは、"HeaderDoc" が指定されています。

	"api_schema": "DPFMBrandDocCreates",
	"accepter": ["HeaderDoc"],

• 全データを取得する際のsample.jsonの記載例(2)

全データを取得する場合、sample.json は以下のように記載します。

	"api_schema": "DPFMBrandDocCreates",
	"accepter": ["All"],

Output

本マイクロサービスでは、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 による 定型フォーマットの出力結果です。