サポートセンター | Data Fabric | ROBON INC.

32.メタデータを同期する(OpenAPI仕様書)

作成者: K|2026/02/28 2:01:46

1. 概要

このページでは、OpenAPI仕様書から各Operation(エンドポイント)およびそのパスパラメータ・クエリパラメータ・リクエストボディ・レスポンスボディをメタデータとしてMashuに同期し、Webアプリ上でデータリネージとメタデータとして一元管理する機能について説明します。

2. 背景と目的

本機能はAPI利用者向けに開発されています。API利用者とは、導入したSaaS製品から提供されたOpenAPI仕様書をもとにAPIを呼び出し、業務システムや外部ツールとデータ連携を行うエンドユーザーを指します。

3. MashuとOpenAPIの対応関係

Mashuのリネージ・メタデータとOpenAPIのオブジェクトの対応関係は以下のようになります。

・データソース:OpenAPI仕様書(YAML・JSONファイル)

・リネージ:Operationオブジェクト

・入力メタデータ:パスパラメータ・クエリパラメータ・リクエストボディ

・出力メタデータ:レスポンスボディ

4. 同期方法

1. データソース(OpenAPI)作成

OpenAPI仕様書からリネージ・メタデータを取り込むために、プロジェクト詳細画面からデータソースを作成します。

データソースのタイプを「OpenAPI」にしてデータソースを作成してください。

2.メタデータ同期

「メタデータ同期」ボタンを押下すると、エクスプローラーが表示されます。同期対象のOpenAPI仕様書ファイルをMashuにアップロードし、メタデータ同期を行います。OpenAPI仕様書に記載されたすべてのOperationをMashuに同期します。

5. 同期結果

メタデータ同期をすると「メタデータ」と「リネージ」をMashu上に取り込みます。