Cette page a été traduite par l'API Cloud Translation.

Générer des bibliothèques clientes

Une version lisible par un ordinateur des définitions du flux de données de bout en bout et de l'API de traitement des commandes est disponible pour générer le code source du client et valider la structure des données JSON. Vous pouvez ainsi consacrer plus de temps au développement des fonctionnalités des applications et de la logique métier nécessaires à l'intégration.

Dans cet exemple, nous utilisons la CLI quicktype pour générer une bibliothèque cliente facile à utiliser.

Télécharger les schémas JSON

Ces versions lisibles par l'ordinateur des flux de données et des API sont nécessaires pour générer et valider du code.

Générer des codes

Quicktype peut être utilisé pour regénérer des codes lorsque les API sont modifiées. Vous pouvez ainsi simplement mettre à jour le code d'application concerné. QuickType est compatible avec C++, Java, JavaScript, Python et d’autres langages de programmation.

Vous pouvez également utiliser d'autres outils générateurs de code compatibles avec les définitions de schéma JSON pour générer les bibliothèques clientes.

Utilisez Node Package Manager (npm) pour installer Quicktype dans le répertoire de projet pour votre intégration de bout en bout des commandes.

npm install quicktype

TypeScript

Générer le code source du client pour les flux de données de commande de bout en bout.

quicktype --lang typescript --src-lang schema inventory-v2-json-schema.json#top_level_definitions/ -o ./owg-inventory.ts

Générer le code source du client pour l'API de fulfillment.

quicktype --lang typescript --src-lang schema fulfillment-actions-json-schema.json#top_level_definitions/ -o ./owg-fulfillment.ts

Générer le code source du client pour l'API Real-time Updates.

quicktype --lang typescript --src-lang schema realtime-updates-json-schema.json#top_level_definitions/ -o ./owg-realtime-updates.ts

Copiez les fichiers générés dans votre espace de travail et implémentez votre logique métier.

Utilisation et validation

Exemple de création d'entités et de conversion au format 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

Générer le code source du client pour les flux de données de commande de bout en bout.

quicktype --lang java --src-lang schema inventory-v2-json-schema.json#top_level_definitions/ -o ./java/ --no-date-times --package com.example.inventory

Générer le code source du client pour l'API de fulfillment.

quicktype --lang java --src-lang schema fulfillment-actions-json-schema.json#top_level_definitions/ -o ./java/ --no-date-times --package com.example.fulfillment

Générer le code source du client pour l'API Real-time Updates.

quicktype --lang java --src-lang schema realtime-updates-json-schema.json#top_level_definitions/ -o ./java/ --no-date-times --package com.example.realtime

Copiez les fichiers générés dans votre espace de travail et implémentez votre logique métier.

Utilisation et validation

Exemple de création d'entités et de conversion au format 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

Générer le code source du client pour les flux de données de commande de bout en bout.

quicktype --lang javascript --src-lang schema inventory-v2-json-schema.json#top_level_definitions/ -o owg-inventory.js

Générer le code source du client pour l'API de fulfillment.

quicktype --lang javascript --src-lang schema fulfillment-actions-json-schema.json#top_level_definitions/ -o owg-fulfillment.js

Générer le code source du client pour l'API Real-time Updates.

quicktype --lang javascript --src-lang schema realtime-updates-json-schema.json#top_level_definitions/ -o owg-realtime-updates.js

Copiez les fichiers générés dans votre espace de travail et implémentez votre logique métier.

Utilisation et validation

Exemple de création d'entités et de conversion au format 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

Générer le code source du client pour les flux de données de commande de bout en bout.

quicktype --lang python --src-lang schema inventory-v2-json-schema.json#top_level_definitions/ -o owg_inventory.py

Générer le code source du client pour l'API de fulfillment.

quicktype --lang python --src-lang schema fulfillment-actions-json-schema.json#top_level_definitions/ -o owg_fulfillment.py

Générer le code source du client pour l'API Real-time Updates.

quicktype --lang python --src-lang schema realtime-updates-json-schema.json#top_level_definitions/ -o owg_realtime_updates.py

Copiez les fichiers générés dans votre espace de travail et implémentez votre logique métier.

Utilisation

Exemple de création d'entités et de conversion au format 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))