このページでは、OpenAPI仕様書から各Operation(エンドポイント)およびそのパスパラメータ・クエリパラメータ・リクエストボディ・レスポンスボディをメタデータとしてMashuに同期し、Webアプリ上でデータリネージとメタデータとして一元管理する機能について説明します。
本機能はAPI利用者向けに開発されています。API利用者とは、導入したSaaS製品から提供されたOpenAPI仕様書をもとにAPIを呼び出し、業務システムや外部ツールとデータ連携を行うエンドユーザーを指します。
Mashuのリネージ・メタデータとOpenAPIのオブジェクトの対応関係は以下のようになります。
・データソース:OpenAPI仕様書(YAML・JSONファイル)
・リネージ:Operationオブジェクト
・入力メタデータ:パスパラメータ・クエリパラメータ・リクエストボディ
・出力メタデータ:レスポンスボディ
OpenAPI仕様書からリネージ・メタデータを取り込むために、プロジェクト詳細画面からデータソースを作成します。
データソースのタイプを「OpenAPI」にしてデータソースを作成してください。
「メタデータ同期」ボタンを押下すると、エクスプローラーが表示されます。同期対象のOpenAPI仕様書ファイルをMashuにアップロードし、メタデータ同期を行います。OpenAPI仕様書に記載されたすべてのOperationをMashuに同期します。
メタデータ同期をすると「メタデータ」と「リネージ」をMashu上に取り込みます。