Test-Json

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

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

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

Das cmdlet Test-Json testet, ob es sich bei einer Zeichenfolge um ein gültiges JSON-Dokument (JavaScript Object Notation) handelt und optional das JSON-Dokument anhand eines bereitgestellten Schemas überprüfen kann.

Die überprüfte Zeichenfolge kann dann mit dem Cmdlet ConvertFrom-Json verwendet werden, um eine JSON-formatierte Zeichenfolge in ein JSON-Objekt zu konvertieren, das einfach in PowerShell verwaltet oder an ein anderes Programm oder Webdienst gesendet wird, das auf JSON-Eingaben zugreift.

Viele Websites verwenden JSON anstelle von XML, um Daten für die Kommunikation zwischen Servern und webbasierten Apps zu serialisieren.

Dieses Cmdlet wurde in PowerShell 6.1 eingeführt.

In diesem Beispiel wird getestet, ob es sich bei der Eingabezeichenfolge um ein gültiges JSON-Dokument handelt.

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

True

In diesem Beispiel wird eine Zeichenfolge mit einem JSON-Schema verwendet und mit einer Eingabezeichenfolge verglichen.

$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 : IntegerExpected: #/age
At line:1 char:37
+ "{'name': 'Ashley', 'age': '25'}" | Test-Json -Schema $schema
+                                     ~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : InvalidData: (:) [Test-Json], Exception
+ FullyQualifiedErrorId : InvalidJsonAgainstSchema,Microsoft.PowerShell.Commands.TestJsonCommand
False

In diesem Beispiel wird ein Fehler angezeigt, da das Schema eine ganze Zahl für Alter erwartet, aber die von uns getestete JSON-Eingabe verwendet stattdessen einen Zeichenfolgenwert.

Weitere Informationen finden Sie unter JSON-Schema-.

Das JSON-Schema kann mithilfe $ref Schlüsselworts auf Definitionen verweisen. Der $ref kann zu einem URI aufgelöst werden, der auf eine andere Datei verweist. Der parameter SchemaFile akzeptiert Literalpfad zur JSON-Schemadatei und ermöglicht es JSON-Dateien, anhand solcher Schemas zu überprüfen.

In diesem Beispiel haben schema.json wir eine Datei, die auf definitions.json.

PS> Get-Content schema.json

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

PS> 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

Weitere Informationen finden Sie unter Strukturieren eines komplexen Schemas.

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Sie können eine JSON-Zeichenfolge an Test-Jsonübergeben.

Das Test-Json Cmdlet wird mithilfe der NJsonSchema-Klasse implementiert.

Seit PowerShell 6 verwendet PowerShell die Newtonsoft.Json-Assemblys für alle JSON-Funktionen. Newtonsofts Implementierung enthält mehrere Erweiterungen für den JSON-Standard, z. B. Unterstützung für Kommentare und Die Verwendung einzelner Anführungszeichen. Eine vollständige Liste der Features finden Sie in der Newtonsoft-Dokumentation unter https://www.newtonsoft.com/json.