Test-Json

Modül:
Microsoft.PowerShell.Utility Module

Dizenin geçerli bir JSON belgesi olup olmadığını sınar

Syntax

__AllParameterSets (Varsayılan) 

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

SchemaString 

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

SchemaFile 

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

Description

Cmdlet, bir dizenin Test-Json geçerli bir JavaScript Nesne Gösterimi (JSON) belgesi olup olmadığını test eder ve isteğe bağlı olarak sağlanan şemada JSON belgesini doğrulayabilir.

Doğrulanmış dize daha sonra cmdlet'iyle birlikte ConvertFrom-Json kullanılabilir. JSON biçimli bir dize, PowerShell'de kolayca yönetilebilen veya JSON girişine erişen başka bir program veya web hizmetine gönderilen bir JSON nesnesine dönüştürülür.

Birçok web sitesi, sunucular ve web tabanlı uygulamalar arasındaki iletişim için verileri seri hale getirmek için XML yerine JSON kullanır.

Bu cmdlet PowerShell 6.1'de kullanıma sunulmuştur

Örnekler

Örnek 1: Nesnenin geçerli bir JSON olup olmadığını test edin

Bu örnek, giriş dizesinin geçerli bir JSON belgesi olup olmadığını test ediyor.

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

True

Örnek 2: Bir nesneyi sağlanan şemaya göre test etme

Bu örnek, JSON şeması içeren bir dize alır ve bunu bir giriş dizesiyle karşılaştırır.

$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

Bu örnekte, şema yaş için bir tamsayı beklediğinden ancak test ettiğimiz JSON girişi bunun yerine bir dize değeri kullandığından bir hata alıyoruz.

Daha fazla bilgi için bkz. JSON Şeması.

Örnek 3: Bir nesneyi dosyadan bir şemaya göre test etme

JSON şeması anahtar sözcüğü kullanarak $ref tanımlara başvurabilir. , $ref başka bir dosyaya başvuran bir URI'ye çözümlenebilir. SchemaFile parametresi, JSON şema dosyasının değişmez yolunu kabul eder ve JSON dosyalarının bu tür şemalarda doğrulanmasına izin verir.

Bu örnekte schema.json dosya başvurur 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

Daha fazla bilgi için bkz. Karmaşık şemayı yapılandırma.

Parametreler

-Json

Geçerliliği test etmek için JSON dizesini belirtir. Dizeyi içeren bir değişken girin veya dizeyi alan bir komut veya ifade yazın. Bir metni Test-Json'e de yöneltebilirsiniz.

Json parametresi gereklidir.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:1
Zorunlu:True
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-Schema

JSON girişinin doğrulanması için bir şema belirtir. Geçirilirse, Test-Json JSON girişinin Schema parametresi tarafından belirtilen belirtime uygun olduğunu doğrular ve yalnızca giriş sağlanan şemaya uygunsa döndürür $true .

Daha fazla bilgi için bkz. JSON Şeması.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

SchemaString
Position:2
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-SchemaFile

JSON girişini doğrulamak için kullanılan bir şema dosyasını belirtir. Kullanıldığında, Test-Json yalnızca JSON girişi $true parametresi tarafından belirtilen dosyada tanımlanan şemaya uygunsa döndürür.

Daha fazla bilgi için bkz. JSON Şeması.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

SchemaFile
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.

Girişler

String

Bir JSON dizesini bu cmdlet'e yöneltebilirsiniz.

Çıkışlar

Boolean

Bu cmdlet, JSON geçerliyse ve değilse $truedöndürür$false.

Notlar

Cmdlet Test-Json , NJsonSchema Sınıfı kullanılarak uygulanır.

PowerShell 6'dan bu yana PowerShell, tüm JSON işlevleri için Newtonsoft.Json derlemelerini kullanır. Newtonsoft'un uygulaması, JSON standardına yönelik açıklamalar için destek ve tek tırnak kullanımı gibi çeşitli uzantılar içerir. Özelliklerin tam listesi için konumundaki https://www.newtonsoft.com/jsonNewtonsoft belgelerine bakın.