使用 JSON 結構定義驗證實體

如要在建立或更新動態饋給時驗證實體,請使用下列 JSON 結構定義。這些結構定義是根據 JSON 結構定義規格建立。您可以新增單元測試來驗證所產生的實體,進而偵測可能影響動態饋給品質的問題。你也可以在動態饋給開發期間使用這些結構定義,避免常見錯誤。

選取媒體動作結構定義

由於這些結構定義可能未實作所有功能,請使用本網站的規格做為可靠來源。

選擇驗證器

您可以在 json-schema.org 上找到驗證器導入程序的清單。

提供的結構定義是使用草稿 7 編寫,因此您選擇的實作方式必須支援這個版本才能正常運作。

驗證範例

以下範例說明如何使用結構定義檔案 schema.jsonjsonschema Python 模組,驗證檔案 feed.json 中的所有實體。實體位於「dataFeedElement」屬性中,如資料動態饋給封套說明文件所述。


    import json
    from jsonschema import validate

    # Loading the schema file
    with open("schema.json", "r") as fp:
        schema = json.load(fp)

    # Opening the feed
    with open("feed.json", "r") as fp:
        feed = json.load(fp)

    # Validating each entity in the feed
    for entity in feed["dataFeedElement"] :
        try:
            validate(schema=schema, instance=entity)
            print("Entity validated successfully")
        except Exception as e:
            # e may contain an explanation as to why the entity wasn't valid
            print("Failed to validate the entity")