Test-Json
Annak vizsgálata, hogy egy sztring érvényes JSON-dokumentum-e
Syntax
Test-Json
[-Json] <String>
[<CommonParameters>]
Test-Json
[-Json] <String>
[[-Schema] <String>]
[<CommonParameters>]
Test-Json
[-Json] <String>
[-SchemaFile <String>]
[<CommonParameters>]
Description
A Test-Json
parancsmag ellenőrzi, hogy egy sztring érvényes JavaScript Object Notation -dokumentum-e, és opcionálisan ellenőrizheti, hogy a JSON-dokumentum egy megadott sémán van-e.
Az ellenőrzött sztring ezután a parancsmaggal ConvertFrom-Json
JSON-formátumú sztringet alakíthat JSON-objektummá, amely könnyen kezelhető a PowerShellben, vagy elküldhető egy másik programnak vagy webszolgáltatásnak, amely hozzáfér a JSON-bemenethez.
Sok webhely az XML helyett JSON-t használ az adatok szerializálására a kiszolgálók és a webalapú alkalmazások közötti kommunikációhoz.
Ez a parancsmag a PowerShell 6.1-ben lett bevezetve
Példák
1. példa: Annak ellenőrzése, hogy egy objektum érvényes JSON-e
Ez a példa azt vizsgálja, hogy a bemeneti sztring érvényes JSON-dokumentum-e.
'{"name": "Ashley", "age": 25}' | Test-Json
True
2. példa: Objektum tesztelése egy megadott sémán
Ez a példa egy JSON-sémát tartalmazó sztringet vesz fel, és összehasonlítja azt egy bemeneti sztringgel.
$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
Ebben a példában hiba jelenik meg, mert a séma egy egész számot vár az életkorhoz, de a tesztelt JSON-bemenet sztringértéket használ.
További információ: JSON-séma.
3. példa: Objektum tesztelése fájlból származó sémán
A JSON-séma kulcsszavak használatával hivatkozhat definíciókra $ref
. Ez $ref
feloldható egy másik fájlra hivatkozó URI-ra. A SchemaFile paraméter elfogadja a JSON-sémafájl konstans elérési útját, és lehetővé teszi a JSON-fájlok érvényesítését az ilyen sémákon.
Ebben a példában a schema.json
fájlhivatkozások 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
További információ: Összetett séma strukturálása.
Paraméterek
-Json
Az érvényesség ellenőrzéséhez használt JSON-sztringet adja meg. Adjon meg egy változót, amely tartalmazza a sztringet, vagy írjon be egy parancsot vagy kifejezést, amely lekéri a sztringet. Sztringet is befűzhet a parancsba Test-Json
.
A Json paraméter megadása kötelező.
Típus: | String |
Position: | 0 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-Schema
Egy sémát ad meg a JSON-bemenet ellenőrzéséhez. Ha átadott, ellenőrzi, Test-Json
hogy a JSON-bemenet megfelel-e a Séma paraméter által megadott specifikációnak, és csak akkor adja vissza $true
, ha a bemenet megfelel a megadott sémának.
További információ: JSON-séma.
Típus: | String |
Position: | 1 |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-SchemaFile
A JSON-bemenet ellenőrzéséhez használt sémafájlt adja meg. Használat esetén a Test-Json
rendszer csak akkor ad vissza értéket$true
, ha a JSON-bemenet megfelel a SchemaFile paraméter által megadott fájlban meghatározott sémának.
További információ: JSON-séma.
Típus: | String |
Position: | 1 |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
Bevitelek
Ehhez a parancsmaghoz JSON-sztringet csövezhet.
Kimenetek
Boolean
Ez a parancsmag akkor ad $true
vissza, ha a JSON érvényes, és egyébként $false
is.
Jegyzetek
A Test-Json
parancsmag az NJsonSchema osztály használatával lett implementálva.
A PowerShell 6 óta a PowerShell a Newtonsoft.Json szerelvényeket használja az összes JSON-függvényhez. A Newtonsoft implementációja számos JSON-bővítményt tartalmaz, például a megjegyzések támogatását és az egyszeri idézőjelek használatát. A funkciók teljes listáját a Newtonsoft dokumentációjában találja: https://www.newtonsoft.com/json.