Test-Json

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

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

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

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

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

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

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

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

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

Cmdleten Test-Json testar om en sträng är ett giltigt JSON-dokument (JavaScript Object Notation) och kan också verifiera JSON-dokumentet mot ett angivet schema.

Den verifierade strängen kan sedan användas med cmdleten ConvertFrom-Json konvertera en JSON-formaterad sträng till ett JSON-objekt, som enkelt hanteras i PowerShell eller skickas till ett annat program eller en annan webbtjänst som har åtkomst till JSON-indata.

Många webbplatser använder JSON i stället för XML för att serialisera data för kommunikation mellan servrar och webbaserade appar.

Den här cmdleten introducerades i PowerShell 6.1

I det här exemplet testas om indatasträngen är ett giltigt JSON-dokument.

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

True

Det här exemplet tar en sträng som innehåller ett JSON-schema och jämför den med en indatasträng.

$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 -ErrorAction SilentlyContinue

False

I det här exemplet använder vi parametern ErrorAction för att utelämna felmeddelandet. Utan den här parametern utlöser kommandot också ett fel eftersom schemat förväntar sig ett heltal för ålder , men JSON-indata som vi testade använder ett strängvärde i stället.

Mer information finns i JSON-schema.

JSON-schema kan referera till definitioner med hjälp av $ref nyckelord. $ref kan matcha till en URI som refererar till en annan fil. Parametern SchemaFile accepterar literalsökvägen till JSON-schemafilen och tillåter att JSON-filer verifieras mot sådana scheman.

I det här exemplet refererar schema.json-filen till 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

Mer information finns i Strukturera ett komplext schema.

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Du kan skicka en JSON-sträng till den här cmdleten.

Den här cmdleten returnerar $true om JSON är giltig och annars $false.

Sedan PowerShell 6 använder PowerShell Newtonsoft.Json-sammansättningarna för JSON-funktioner. Newtonsofts implementering innehåller flera tillägg till JSON-standarden, till exempel stöd för kommentarer och användning av enkla citattecken. En fullständig lista över funktioner finns i Newtonsoft-dokumentationen på https://www.newtonsoft.com/json.

Från och med PowerShell 7.4 använder Test-JsonSystem.Text.Json för JSON-parsning och JsonSchema.NET för schemaverifiering. Med dessa ändringar Test-Json:

• Stöder inte längre utkast 4-scheman
• Stöder endast strikt överensstämmande JSON

En fullständig lista över skillnader mellan Newtonsoft.Json och System.Text.Json finns i tabell med skillnader i Migrera från Newtonsoft.Json till System.Text.Json.

Mer information om JSON-schemaspecifikationer finns i dokumentationen på JSON-Schema.org.