JSONなどからのSchema生成

Schemaを作成する際、Apidogは既存のデータからSchemaを素早く識別して作成できる非常に便利なツールを提供している。JSONなどから生成 をクリックすると、データ構造インポートツールに入る。

ここでは、JSON、XML、JSON Schema を貼り付け、データベースからインポート でき、Apidogはそのデータに基づいて自動的にSchemaを生成する。

JSON/XMLからの生成

JSON/XMLの場合、既存のJSONまたはXMLを指定された領域に貼り付けるだけで、自動的に認識され、対応するSchemaとデータタイプに変換される。

JSONのスマート認識は、提供されたJSONに基づいてデータ構造を生成するもので、JSON自体に含まれる値は保存しない

JSON/XMLに表示されるすべてのプロパティは 必須 として扱われる

説明やモックなどのフィールドは空白のままとなる

上書きモード

2回目に JSONから生成 を行う場合、新しくインポートされたデータは既に生成されている既存のSchemaを上書きする。このシナリオでは、2つの 上書きモード がある：

マージ（デフォルト）：一致するキーが見つかった場合、元のSchemaのモックと説明が保持される

上書き：既存のデータはすべて破棄され、新しいデータが古いデータを完全に置き換える

命名スタイル

適切な命名スタイルを選択できる：

そのまま保持

camelCase

PascalCase

snake_case

例として保存

リクエストボディまたはレスポンスで JSONから生成 を使用する際、例として保存 を有効にすると、Schemaを生成する際に現在のJSON/XMLをリクエスト/レスポンス例として含める。

JSON Schemaからの生成

JSON Schemaを貼り付けるだけで、データ構造を視覚的に認識できる。

データベースからのインポート

ApidogはデータベーステーブルからのSchema生成に2つの方法をサポートしている。1つ目の方法はデータベースに直接接続してテーブル構造を読み取る方法で、2つ目の方法はSQL DDLを貼り付けてテーブル構造を認識する方法だ。

データベース接続

データベースからSchemaをインポートするには、以下の手順に従う：

データベース接続を設定する。データベース接続の管理について詳しく見る。

Apidog無料版はMySQL、SQL Server、Oracle、PostgreSQLデータベースをサポートし、有料版ではClickHouse、MongoDB、Redisのサポートも含まれる。

データベースからインポートでデータベース接続を選択する

インポートするテーブルを選択する

インポートオプションを設定する。具体的な設定については、前述のJSON/XMLの取り扱いに関するセクションを参照

データベースのフィールド長に従う トグルが有効な場合、Apidogはテーブルで定義されたフィールド長に基づいてプロパティの最小値と最大値を設定する。

SQLの入力（DDL）

データベーステーブルの CREATE 文（DDL）を貼り付けてSchemaを生成する。MySQLと互換性のあるSQLをサポート。

具体的な設定については、前述のJSON/XMLの取り扱いに関するセクションを参照。

JSONなどからのSchema生成

JSON/XMLからの生成#

上書きモード#

命名スタイル#

例として保存#

JSON Schemaからの生成#

データベースからのインポート#

データベース接続#

SQLの入力（DDL）#

JSON/XMLからの生成

上書きモード

命名スタイル

例として保存

JSON Schemaからの生成

データベースからのインポート

データベース接続

SQLの入力（DDL）