Generator schematu JSON
Automatycznie generuj schemat JSON z danych JSON
Wejście JSON
Wygenerowany schemat
Czym jest generator schematu JSON?
Czy zdarzyło Ci się pisać JSON Schema od zera ręcznie? To żmudna robota. To narzędzie robi to za Ciebie — wklej przykładowy obiekt JSON, a ono natychmiast wygeneruje schemat opisujący tę strukturę: typy, właściwości, wymagane pola i zagnieżdżone obiekty. Wygenerowany schemat jest zgodny z konwencjami JSON z RFC 8259 i kompatybilny z narzędziami takimi jak Ajv. Użyj go jako punktu wyjścia do dokumentacji API, walidacji potoków danych lub tworzenia schematów dla specyfikacji OpenAPI.
To narzędzie działa w przeglądarce. Wklej JSON, a zostanie wygenerowany szkic schematu JSON. Żadne dane nie są wysyłane na serwer.
Jak korzystać z tego narzędzia
Wklej przykładowy JSON
Wklej JSON reprezentujący strukturę, którą chcesz opisać. W razie potrzeby użyj Przykładu lub Wczytaj. Generator wnioskuje typy z wartości (string, number, boolean, array, object).
Przejrzyj schemat
Prawy panel pokazuje wygenerowany schemat. Może zawierać type, properties, required oraz zagnieżdżone schematy dla obiektów. W razie potrzeby możesz go ręcznie edytować.
Kopiuj lub pobierz
Użyj Kopiuj lub Pobierz aby uzyskać schemat. Do walidacji JSON względem schematu użyj Walidatora JSON lub biblioteki takiej jak Ajv.
Przykłady schematu JSON
Wygeneruj schemat z przykładowego JSON. Przykład z branży telekomunikacyjnej:
Wejście JSON
Wygenerowany schemat
Kiedy używać wygenerowanego schematu
Wygenerowane schematy są punktem wyjścia. Rejestrują strukturę danych przykładowych, ale mogą być zbyt restrykcyjne lub zbyt luźne. Może być konieczne dodanie tablic required, dostosowanie typów lub dodanie enum dla dozwolonych wartości. Dokumentacja JSON Schema wyjaśnia pełne słownictwo. Do dokumentacji API narzędzia takie jak OpenAPI mogą odwoływać się do schematu JSON.
Przykład: Generowanie schematu z obiektu użytkownika
Wejście JSON:
{
"id": 1,
"name": "Alice",
"email": "[email protected]",
"age": 30,
"active": true
}Wygenerowany schemat JSON:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" },
"email": { "type": "string" },
"age": { "type": "integer" },
"active": { "type": "boolean" }
}
}Często zadawane pytania
Czy mogę walidować JSON za pomocą tego schematu?
To narzędzie tylko generuje schematy. Do walidacji użyj Walidatora JSON lub biblioteki takiej jak Ajv w swoim kodzie.
Co jeśli mój JSON ma różne kształty?
Generator wnioskuje z dostarczonej próbki. Jeśli JSON może mieć wiele kształtów (np. opcjonalne pola), schemat może wymagać ręcznych edycji. Użyj oneOf lub anyOf dla wariantów.
Czy dane są wysyłane gdzieś?
Nie. Generowanie odbywa się w przeglądarce.
Która wersja szkicu JSON Schema jest używana?
Narzędzie może używać draft-07 lub draft-2020-12. Sprawdź $schema w wygenerowanym schemacie, aby zobaczyć wersję. Specyfikacja JSON Schema zawiera szczegóły.
Czy mogę używać tego do odpowiedzi API?
Tak. Wklej typową odpowiedź API. Wygenerowany schemat opisze tę strukturę. Możesz go następnie użyć w OpenAPI/Swagger lub do dokumentacji.
Powiązane narzędzia
Więcej na json-schema.org i JSON Schema Learn. Do walidacji w kodzie zob. Ajv. Dla JSON: json.org, MDN, RFC 8259. Do dokumentacji API: OpenAPI.