クライアント ライブラリの生成

機械が読み取り可能なバージョンの Ordering End-to-End データフィードとフルフィルメント API 定義が提供されており、クライアント ソースコードを生成して JSON データの構造を検証できます。これにより、統合に必要なアプリケーション機能とビジネス ロジックの開発に多くの時間を割くことができます。

この例では、quicktype CLI を使用して、使いやすいクライアント ライブラリを生成します。

JSON スキーマをダウンロードする

これらの機械で読み取り可能なデータフィードと API は、コードの生成と検証に必要です。

コードを生成

Quicktype を使用すると、API が変更されたときにコードを再生成できるため、影響を受けるアプリケーション コードを簡単に更新できます。QuickType は、C++、Java、JavaScript、Python などのプログラミング言語をサポートしています。

JSON スキーマ定義をサポートする他のコード生成ツールを使用して、クライアント ライブラリを生成することもできます。

Node Package Manager（npm）を使用して、Ordering End-to-End 統合のプロジェクト ディレクトリに quicktype をインストールします。

npm install quicktype

TypeScript

  1. エンドツーエンドの注文データフィード用のクライアント ソースコードを生成します。 
    quicktype --lang typescript --src-lang schema inventory-v2-json-schema.json#top_level_definitions/ -o ./owg-inventory.ts
  2. フルフィルメント API のクライアント ソースコードを生成する。
    quicktype --lang typescript --src-lang schema fulfillment-actions-json-schema.json#top_level_definitions/ -o ./owg-fulfillment.ts
  3. リアルタイム更新 API のクライアント ソースコードを生成する。
    quicktype --lang typescript --src-lang schema realtime-updates-json-schema.json#top_level_definitions/ -o ./owg-realtime-updates.ts
  4. 生成されたファイルをワークスペースにコピーし、ビジネス ロジックを実装します。

使用と検証

エンティティを作成して JSON に変換する例:

import { Convert, Fee, OperationHours, Restaurant, Service, ServiceArea,
    ServiceHours, Menu, MenuSection, Availability, MenuItem, MenuItemOption,
    MenuItemOffer, FeeType, FeeTypeEnum, RestaurantType } from './owg-inventory';

const restaurant: Restaurant = {
    "@id": "McDonalds",
    "@type": RestaurantType.Restaurant,
    "addressCountry": "US",
    "addressLocality": "123 Local",
    "addressRegion": "Region",
    "name": "MacDonald's",
    "postalCode": "1234",
    "streetAddress": "123",
    "telephone": "+15552999983",
    "url": "https://example.com",
    "dateModified": new Date()
}

const fee: Fee = {
    "@id": "123",
    "@type": FeeTypeEnum.Fee,
    "priceCurrency": "US",
    "serviceId": "123",
    "feeType": FeeType.Delivery,
    "dateModified": new Date()
}
const restaurantJson: string = Convert.restaurantToJson(restaurant);
const feeJson: string = Convert.feeToJson(fee);

Java

  1. エンドツーエンドの注文データフィード用のクライアント ソースコードを生成します。 
    quicktype --lang java --src-lang schema inventory-v2-json-schema.json#top_level_definitions/ -o ./java/ --no-date-times --package com.example.inventory
  2. フルフィルメント API のクライアント ソースコードを生成する。
    quicktype --lang java --src-lang schema fulfillment-actions-json-schema.json#top_level_definitions/ -o ./java/ --no-date-times --package com.example.fulfillment
  3. リアルタイム更新 API のクライアント ソースコードを生成する。
    quicktype --lang java --src-lang schema realtime-updates-json-schema.json#top_level_definitions/ -o ./java/ --no-date-times --package com.example.realtime
  4. 生成されたファイルをワークスペースにコピーし、ビジネス ロジックを実装します。

使用と検証

エンティティを作成して JSON に変換する例:

package com.example;
import com.example.inventory.Converter;
import com.example.inventory.Fee;
import com.example.inventory.FeeType;
import com.example.inventory.Restaurant;
import com.example.inventory.RestaurantType;
public class FoodOrderingResponse {
    public static void main(String[] args) {
        Restaurant restaurant = new Restaurant();
        restaurant.setId("MacDonalds");
        restaurant.setType(RestaurantType.RESTAURANT);
        restaurant.setAddressCountry("US");
        restaurant.setAddressLocality("123 Local");
        restaurant.setAddressRegion("Region");
        restaurant.setName("MacDonald's");
        restaurant.setPostalCode("1234");
        restaurant.setStreetAddress("123");
        restaurant.setTelephone("+15552999983");
        restaurant.setUrl("https://example.com");
        restaurant.setDateModified("2022-09-19T13:10:00.000Z");

        Fee fee = new Fee();
        fee.setId("123");
        fee.setType(FeeTypeEnum.FEE);
        fee.setPriceCurrency("US");
        fee.setServiceId("123");
        fee.setFeeType(FeeType.DELIVERY);
        fee.setDateModified("2022-09-19T13:13:10.000Z");

        String restaurantJson = Converter.RestaurantToJsonString(restaurant);
        String feeJson = Converter.FeeToJsonString(fee);
    }
}

JavaScript

  1. エンドツーエンドの注文データフィード用のクライアント ソースコードを生成します。 
    quicktype --lang javascript --src-lang schema inventory-v2-json-schema.json#top_level_definitions/ -o owg-inventory.js
  2. フルフィルメント API のクライアント ソースコードを生成する。
    quicktype --lang javascript --src-lang schema fulfillment-actions-json-schema.json#top_level_definitions/ -o owg-fulfillment.js
  3. リアルタイム更新 API のクライアント ソースコードを生成する。
    quicktype --lang javascript --src-lang schema realtime-updates-json-schema.json#top_level_definitions/ -o owg-realtime-updates.js
  4. 生成されたファイルをワークスペースにコピーし、ビジネス ロジックを実装します。

使用と検証

エンティティを作成して JSON に変換する例:

// Converts JSON strings to/from your types
// and asserts the results of JSON.parse at runtime
const Convert = require("./owg-inventory");

const restaurantJson = Convert.restaurantToJson({
    "@id": "McDonalds",
    "@type": 'Restaurant',
    "addressCountry": "US",
    "addressLocality": "123 Local",
    "addressRegion": "Region",
    "name": "MacDonald's",
    "postalCode": "1234",
    "streetAddress": "123",
    "telephone": "+15552999983",
    "url": "https://example.com",
    "dateModified": new Date()
}));

const restaurant = Convert.toRestaurant(restaurantJson);

Python

  1. エンドツーエンドの注文データフィード用のクライアント ソースコードを生成します。 
    quicktype --lang python --src-lang schema inventory-v2-json-schema.json#top_level_definitions/ -o owg_inventory.py
  2. フルフィルメント API のクライアント ソースコードを生成する。
    quicktype --lang python --src-lang schema fulfillment-actions-json-schema.json#top_level_definitions/ -o owg_fulfillment.py
  3. リアルタイム更新 API のクライアント ソースコードを生成する。
    quicktype --lang python --src-lang schema realtime-updates-json-schema.json#top_level_definitions/ -o owg_realtime_updates.py
  4. 生成されたファイルをワークスペースにコピーし、ビジネス ロジックを実装します。

用途

エンティティを作成して JSON に変換する例:

import json
import owg_inventory

restaurant: owg_inventory.Restaurant = owg_inventory.restaurant_from_dict({
    "@id": "McDonalds",
    "@type": "Restaurant",
    "addressCountry": "US",
    "addressLocality": "123 Local",
    "addressRegion": "Region",
    "name": "MacDonald's",
    "postalCode": "1234",
    "streetAddress": "123",
    "telephone": "+15552999983",
    "url": "https://example.com",
    "dateModified": "2022-09-19T13:10:00.000Z"
})
restaurant_json: str = json.dumps(owg_inventory.restaurant_to_dict(restaurant))