Przegląd

Struktura pliku danych o zamówieniach typu end-to-end jest definiowana przez relacyjny schemat asortymentu. Plik danych „Zamówienie od początku do końca” składa się z tych elementów najwyższego poziomu:

Na diagramie poniżej widać, jak elementy Service, Restaurant i Menu reprezentują jedną restaurację:

Diagram relacji klasy Menu usługi restauracji
Ilustracja 1.: ogólny związek między elementami pliku danych kompleksowego zamawiania: usługa, restauracja i menu

Ogólne wskazówki

  • Restauracje w poszczególnych plikach: każdy plik danych powinien reprezentować jedną restaurację z powiązanymi elementami Service i Menu. Używaj nazw plików, które ułatwiają wyszukiwanie pliku restauracji.

  • Format pliku danych: pliki danych muszą być sformatowane w postaci plików JSON oddzielonych znakami nowego wiersza (format ndjson).

  • Wartości daty i godziny: w przypadku właściwości, które wymagają wartości DateTime lub Time, użyj formatów określonych w Formatach daty i godziny. Na przykład 2017-05-01T06:30:00+05:30 dla DateTime i T08:08:00+05:30 dla Time.

  • Identyfikatory: użyj właściwości @id, aby zidentyfikować wszystkie unikalne elementy w danym typie. Maksymalna długość to 300 znaków. @id to unikalny identyfikator jednostki danego typu, ale identyfikatory mogą się pokrywać w przypadku różnych jednostek. Załóżmy na przykład, że definiujesz element Service z właściwością @id ustawioną na a16. Nie możesz utworzyć innego elementu Service z @id a16. Możesz jednak użyć wartości a16 jako wartości @id elementu Menu.

  • Generowanie identyfikatorów: zachowaj stabilność identyfikatorów – nie używaj identyfikatorów UUID ani nie zmieniaj ani nie losuj identyfikatorów między przesyłanymi plikami danych. Dzięki temu łatwiej będzie uzyskać pomoc w przypadku problemów związanych z podmiotem.

  • Wartości null: nie używaj wartości null zamiast obiektów. Jeśli obiekt jest opcjonalny, musisz pominąć go w pliku danych.

Biblioteki klienta

W sekcji Narzędzia dostępny jest Generator kodu klienta, który umożliwia sprawdzanie danych w pliku danych o zamówieniach od początku do końca.

Dalej
Szybki start