Test-Json

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Testa se uma cadeia de caracteres é um documento JSON válido

Syntax

Test-Json
    [-Json] <String>
    [<CommonParameters>]
Test-Json
    [-Json] <string>
    [-Schema] <string>
    [<CommonParameters>]
Test-Json
    [-Json] <string>
    [-SchemaFile] <string>
    [<CommonParameters>]
Test-Json
    [-Path] <string>
    [<CommonParameters>]
Test-Json
    [-Path] <string>
    [-Schema] <string>
    [<CommonParameters>]
Test-Json
    [-Path] <string>
    [-SchemaFile] <string>
    [<CommonParameters>]
Test-Json
    [-LiteralPath] <string>
    [<CommonParameters>]
Test-Json
    [-LiteralPath] <string>
    [-Schema] <string>
    [<CommonParameters>]
Test-Json
    [-LiteralPath] <string>
    [-SchemaFile] <string>
    [<CommonParameters>]

Description

O Test-Json cmdlet testa se uma cadeia de caracteres é um documento JSON (JavaScript Object Notation) válido e, opcionalmente, pode verificar esse documento JSON em relação a um esquema fornecido.

A cadeia de caracteres verificada pode então ser usada com o ConvertFrom-Json cmdlet converter uma cadeia de caracteres formatada em JSON em um objeto JSON, que é facilmente gerenciado no PowerShell ou enviado para outro programa ou serviço Web que acessa a entrada JSON.

Muitos sites usam JSON em vez de XML para serializar dados para a comunicação entre servidores e aplicativos baseados na web.

Esse cmdlet foi introduzido no PowerShell 6.1

Exemplos

Exemplo 1: Testar se um objeto é JSON válido

Este exemplo testa se a cadeia de caracteres de entrada é um documento JSON válido.

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

True

Exemplo 2: Testar um objeto em relação a um esquema fornecido

Este exemplo pega uma cadeia de caracteres que contém um esquema JSON e a compara a uma cadeia de caracteres de entrada.

$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
     |                                      ~~~~~~~~~~~~~~~~~~~~~~~~~
     | The JSON is not valid with the schema: Value is "string" but should be "integer" at '/age'
False

Neste exemplo, obtemos um erro porque o esquema espera um inteiro para a idade , mas a entrada JSON que testamos usa um valor de cadeia de caracteres.

Para obter mais informações, consulte Esquema JSON.

Exemplo 3: Testar um objeto em relação a um esquema do arquivo

O esquema JSON pode fazer referência a definições usando $ref palavra-chave. O $ref pode resolver para um URI que faz referência a outro arquivo. O parâmetro SchemaFile aceita o caminho literal para o arquivo de esquema JSON e permite que os arquivos JSON sejam validados em relação a esses esquemas.

Neste exemplo, o schema.json arquivo faz referência definitions.jsona .

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

Para obter mais informações, consulte Estruturando um esquema complexo.

Parâmetros

-Json

Especifica a cadeia de caracteres JSON a ser testada quanto à validade. Insira uma variável que contenha a cadeia de caracteres ou digite um comando ou expressão que obtenha essa cadeia. Você também pode canalizar uma cadeia de caracteres para Test-Json.

O parâmetro Json é obrigatório.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

Especifica um caminho para um arquivo JSON. O valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Esse parâmetro foi adicionado no PowerShell 7.4.

Type:String
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Path

Especifica o caminho para um arquivo JSON. Esse cmdlet obtém o item no local especificado. Caracteres curinga são permitidos, mas o padrão deve ser resolvido para um único arquivo.

Esse parâmetro foi adicionado no PowerShell 7.4.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-Schema

Especifica um esquema para validar a entrada JSON. Se aprovada, Test-Json valida se a entrada JSON está em conformidade com a especificação especificada pelo parâmetro Schema e retorna $true somente se a entrada estiver em conformidade com o esquema fornecido.

Para obter mais informações, consulte Esquema JSON.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SchemaFile

Especifica um arquivo de esquema usado para validar a entrada JSON. Quando usado, o Test-Json retorna $true somente se a entrada JSON estiver em conformidade com o esquema definido no arquivo especificado pelo parâmetro SchemaFile .

Para obter mais informações, consulte Esquema JSON.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

Você pode canalizar uma cadeia de caracteres JSON para esse cmdlet.

Saídas

Boolean

Esse cmdlet retorna $true se o JSON é válido e se $falseo .

Observações

Desde o PowerShell 6, o PowerShell usa os assemblies Newtonsoft.Json para funções JSON. A implementação da Newtonsoft inclui várias extensões para o padrão JSON, como suporte para comentários e uso de aspas simples. Para obter uma lista completa de recursos, consulte a documentação da Newtonsoft em https://www.newtonsoft.com/json.

A partir do PowerShell 7.4, Test-Json usa System.Text.Json para análise JSON e JsonSchema.NET para validação de esquema. Com essas mudanças, Test-Json:

  • Não suporta mais esquemas de rascunho 4
  • Suporta apenas JSON estritamente conforme

Para obter uma lista completa das diferenças entre Newtonsoft.Json e System.Text.Json, consulte a Tabela de diferenças em Migrar de Newtonsoft.Json para System.Text.Json.

Para obter mais informações sobre especificações de esquema JSON, consulte a documentação em JSON-Schema.org.