スキーマの作成

tip

データモデル、インターフェース入力パラメータ定義、またはインターフェースレスポンス期待定義では、データ構造がインターフェース設計のためにjsonschemaを視覚的に定義するために使用されることがよくあります。

データモデルの作成

新しいモデルエントリ

tip

モデル名: 必須であり、一意でなければならず、通常は文字、数字、アンダースコアで構成されます。
エイリアス: 検索や表示を容易にするための名前です。
ディレクトリ: モデルは管理のためにカテゴリ分けできます。
備考: モデルの目的を説明するために使用されます。

データモデルの編集

次のオプションを使用して、スキーマを視覚的に編集できます。

ノードの追加または削除
フィールドタイプの変更
フィールドが必須か空白にできるかを設定
フィールドのモックタイプを定義
フィールドの順序を再配置

インテリジェントインポート

既存の構造ファイルに対して、インテリジェントインポートを通じてJSON Schemaの構造を迅速に生成でき、面倒な手動入力を回避できます。サポートされているフォーマットにはJSON、XML、JSON Schema、およびMySQL DDLが含まれます。

Jsonの例

{
    "userInfo_get_response": {
        "result": {
            "model": {
                "open_id": "qwertyuiuduiasd",
                "avatar": "avatar url",
                "nick": "snsNick"
            },
            "err_message": "err_message",
            "err_code": "err_code",
            "success": false
        }
    }
}

Xmlの例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>Illegal parameter</sub_msg>
</error_response>

Jsonschemaの例

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Person Schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the person.",
      "minLength": 2
    },
    "age": {
      "description": "Age in years which must be equal to or greater than zero.",
      "type": "integer",
      "minimum": 0
    },
    "email": {
      "type": "string",
      "description": "The email address of the person.",
      "format": "email"
    }
  },
  "required": ["name", "age", "email"]
}

MySQL DDLの例

CREATE TABLE orders (
    order_id INT AUTO_INCREMENT PRIMARY KEY,
    customer_id INT NOT NULL,
    order_date DATE NOT NULL,
    total_amount DECIMAL(10, 2) NOT NULL,
    status VARCHAR(50) NOT NULL,
    FOREIGN KEY (customer_id) REFERENCES customers(customer_id)
);