Udostępnij za pośrednictwem

Test-Json

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Sprawdza, czy ciąg jest prawidłowym dokumentem JSON

Składnia

Test-Json
    [-Json] <String>
    [<CommonParameters>]
Test-Json
    [-Json] <String>
    [[-Schema] <String>]
    [<CommonParameters>]
Test-Json
    [-Json] <String>
    [-SchemaFile <String>]
    [<CommonParameters>]

Opis

Polecenie cmdlet Test-Json sprawdza, czy ciąg jest prawidłowym dokumentem JavaScript Object Notation (JSON) i opcjonalnie może sprawdzić, czy dokument JSON jest dokumentem JSON względem podanego schematu.

Zweryfikowany ciąg może być następnie używany z poleceniem cmdlet ConvertFrom-Json przekonwertować ciąg w formacie JSON na obiekt JSON, który jest łatwo zarządzany w programie PowerShell lub wysyłany do innego programu lub usługi internetowej, która uzyskuje dostęp do danych wejściowych JSON.

Wiele witryn sieci Web używa formatu JSON zamiast XML do serializacji danych na potrzeby komunikacji między serwerami i aplikacjami internetowymi.

To polecenie cmdlet zostało wprowadzone w programie PowerShell 6.1

Przykłady

Przykład 1. Testowanie, czy obiekt jest prawidłowym kodem JSON

W tym przykładzie sprawdza się, czy ciąg wejściowy jest prawidłowym dokumentem JSON.

'{"name": "Ashley", "age": 25}' | Test-Json

True

Przykład 2. Testowanie obiektu względem podanego schematu

W tym przykładzie ciąg zawiera schemat JSON i porównuje go z ciągiem wejściowym.

$schema = @'
{
  "definitions": {},
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://example.com/root.json",
  "type": "object",
  "title": "The Root Schema",
  "required": [
    "name",
    "age"
  ],
  "properties": {
    "name": {
      "$id": "#/properties/name",
      "type": "string",
      "title": "The Name Schema",
      "default": "",
      "examples": [
        "Ashley"
      ],
      "pattern": "^(.*)$"
    },
    "age": {
      "$id": "#/properties/age",
      "type": "integer",
      "title": "The Age Schema",
      "default": 0,
      "examples": [
        25
      ]
    }
  }
}
'@
'{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema

Test-Json:
Line |
  35 |  '{"name": "Ashley", "age": "25"}' | Test-Json -Schema $schema
     |                                      ~~~~~~~~~~~~~~~~~~~~~~~~~
     | IntegerExpected: #/age
False

W tym przykładzie występuje błąd, ponieważ schemat oczekuje liczby całkowitej dla wieku, ale testowane dane wejściowe JSON używają wartości ciągu.

Aby uzyskać więcej informacji, zobacz schemat JSON.

Przykład 3. Testowanie obiektu względem schematu z pliku

Schemat JSON może odwoływać się do definicji przy użyciu słowa kluczowego $ref. $ref może rozpoznać identyfikator URI, który odwołuje się do innego pliku. Parametr SchemaFile akceptuje ścieżkę literału do pliku schematu JSON i umożliwia sprawdzanie poprawności plików JSON względem takich schematów.

W tym przykładzie plik schema.json odwołuje się definitions.json.

Get-Content schema.json

{
  "description":"A person",
  "type":"object",
  "properties":{
    "name":{
      "$ref":"definitions.json#/definitions/name"
    },
    "hobbies":{
      "$ref":"definitions.json#/definitions/hobbies"
    }
  }
}

Get-Content definitions.json

{
  "definitions":{
    "name":{
      "type":"string"
    },
    "hobbies":{
      "type":"array",
      "items":{
        "type":"string"
      }
    }
  }
}

'{"name": "James", "hobbies": [".NET", "Blogging"]}' | Test-Json -SchemaFile 'schema.json'

True

Aby uzyskać więcej informacji, zobacz Strukturyzowanie złożonego schematu.

Parametry

-Json

Określa ciąg JSON do przetestowania pod kątem ważności. Wprowadź zmienną zawierającą ciąg lub wpisz polecenie lub wyrażenie, które pobiera ciąg. Możesz również przekazać ciąg do Test-Json.

Wymagany jest parametr Json .

Typ:String
Position:1
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Schema

Określa schemat do sprawdzania poprawności danych wejściowych JSON. W przypadku przekazania Test-Json sprawdza, czy dane wejściowe JSON są zgodne ze specyfikacją określoną przez parametr Schema i zwracają $true tylko wtedy, gdy dane wejściowe są zgodne z podanym schematem.

Aby uzyskać więcej informacji, zobacz schemat JSON.

Typ:String
Position:2
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-SchemaFile

Określa plik schematu używany do sprawdzania poprawności danych wejściowych JSON. W przypadku użycia Test-Json zwraca $true tylko wtedy, gdy dane wejściowe JSON są zgodne ze schematem zdefiniowanym w pliku określonym przez parametr SchemaFile.

Aby uzyskać więcej informacji, zobacz schemat JSON.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

String

Do tego polecenia cmdlet można przekazać ciąg JSON.

Dane wyjściowe

Boolean

To polecenie cmdlet zwraca $true, jeśli kod JSON jest prawidłowy i w przeciwnym razie $false.

Uwagi

Polecenie cmdlet Test-Json jest implementowane przy użyciu klasy NJsonSchema.

Ponieważ program PowerShell 6 używa zestawów Newtonsoft.Json dla wszystkich funkcji JSON. Implementacja rozwiązania Newtonsoft obejmuje kilka rozszerzeń standardu JSON, takich jak obsługa komentarzy i używanie pojedynczych cudzysłowów. Aby uzyskać pełną listę funkcji, zobacz dokumentację usługi Newtonsoft pod adresem https://www.newtonsoft.com/json.