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

De Test-Json cmdlet test of een tekenreeks een geldig JSON-document (JavaScript Object Notation) is en optioneel kan controleren of het JSON-document in een opgegeven schema is.

De geverifieerde tekenreeks kan vervolgens worden gebruikt met de cmdlet ConvertFrom-Json een tekenreeks met JSON-indeling converteert naar een JSON-object, dat eenvoudig wordt beheerd in PowerShell of wordt verzonden naar een ander programma of een andere webservice die toegang heeft tot JSON-invoer.

Veel websites gebruiken JSON in plaats van XML om gegevens te serialiseren voor communicatie tussen servers en web-apps.

Deze cmdlet is geïntroduceerd in PowerShell 6.1

In dit voorbeeld wordt getest of de invoertekenreeks een geldig JSON-document is.

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

True

In dit voorbeeld wordt een tekenreeks met een JSON-schema gebruikt en vergeleken met een invoertekenreeks.

$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

In dit voorbeeld gebruiken we de parameter ErrorAction om het foutbericht te onderdrukken. Zonder deze parameter voert de opdracht ook een fout uit omdat in het schema een geheel getal wordt verwacht voor leeftijd , maar de JSON-invoer die we hebben getest, gebruikt in plaats daarvan een tekenreekswaarde.

Zie JSON-schemavoor meer informatie.

JSON-schema kan verwijzen naar definities met behulp van $ref trefwoord. De $ref kan worden omgezet in een URI die verwijst naar een ander bestand. De parameter SchemaFile accepteert het letterlijke pad naar het JSON-schemabestand en staat toe dat JSON-bestanden worden gevalideerd op basis van dergelijke schema's.

In dit voorbeeld verwijst het schema.json bestand naar 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

Zie Een complex schema structurerenvoor meer informatie.

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

U kunt een JSON-tekenreeks naar deze cmdlet doorsluisen.

Deze cmdlet retourneert $true als de JSON geldig is en anders $false.

Sinds PowerShell 6 gebruikt PowerShell de Newtonsoft.Json-assembly's voor JSON-functies. De implementatie van Newtonsoft bevat verschillende extensies voor de JSON-standaard, zoals ondersteuning voor opmerkingen en het gebruik van enkele aanhalingstekens. Zie de Newtonsoft-documentatie op https://www.newtonsoft.com/jsonvoor een volledige lijst met functies.

Vanaf PowerShell 7.4 gebruikt Test-JsonSystem.Text.Json- voor JSON-parsering en JsonSchema.NET voor schemavalidatie. Met deze wijzigingen Test-Json:

• Biedt geen ondersteuning meer voor Concept 4-schema's
• Ondersteunt alleen strikt conforme JSON

Zie de tabel met verschillen in Migrate van Newtonsoft.Json naar System.Text.Jsonvoor een volledige lijst met verschillen tussen Newtonsoft.Json en System.Text.Json.

Zie de documentatie op JSON-Schema.orgvoor meer informatie over JSON-schemaspecificaties.