{{< jsoneditor >}}

Description#

Le shortcode jsoneditor permet d’afficher un formulaire basé sur un JSON Schema. Ce formulaire peut être utilisé pour exporter (copier dans le presse-papiers/télécharger en tant que fichier) le JSON associé.

Paramètres#

NomType(nommé/positionnel)Description
sourcenomméSource du JSON Schema.
NB: La source peut-etre définie par un chemin local ou une URL.
postAnalyzeFunctionnommé

Nom de la méthode globale Javascript utilisé pour exécuter une validation spécifique et supplémentaire juste après la validation standard Jsoneditor.

  • input: JSON Schema, JSON généré depuis le JSON Schema par Jsoneditor
  • output: List d’erreurs (Liste vide si aucune erreur), avec les erreurs de la forme:
    {
  path: [CHEMIN_DU_CHAMP_EN_ERREUR],
  message: [MESSAGE_D'ERREUR]
}
postProcessFunctionnommé

Nom de la méthode globale Javascript utilisée pour exécuter un processus spécifique et supplémentaire juste après la génération standard du JSON de Jsoneditor.

  • input: JSON Schema, JSON généré depuis le JSON Schema par Jsoneditor
  • output: JSON à exporter
filenameToDownloadFunctionnommé

Nom de la méthode globale Javascript utilisée pour définir le nom du fichier à télécharger.

  • input: JSON Schema, JSON généré depuis le JSON Schema par Jsoneditor
  • output: Nom du fichier à télécharger

NB: Par défaut le nom du fichier est égal au schema.title ou en dernier recours à l’ID du conteneur HTML jsoneditor.

jsoneditor.js
// Function to run additionnal process after standard JSON Schema validation in jsoneditor
window.examplePostAnalyzeFunction = function examplePostAnalyzeFunction(schema, json) {
  return [{path: 'root.dummy', message: 'A dummy error'}]
}
// Function to run additionnal process after standard JSON process in jsoneditor
window.examplePostProcessFunction = function examplePostProcessFunction(schema, json) {
  return 'An example post process JSON'
}
// Function to define filename to download
window.exampleFilenameToDownloadFunction = function exampleFilenameToDownloadFunction(schema, json) {
  return 'exampleFile.json'
}

Exemples#

MarkdownRendu
{{</* jsoneditor source="https://raw.githubusercontent.com/json-schema-org/website/main/public/data/getting-started-examples/schemas/default.json" */>}}
Chargement
{{</* jsoneditor
  source="https://raw.githubusercontent.com/json-schema-org/website/main/public/data/getting-started-examples/schemas/default.json"
  postAnalyzeFunction="examplePostAnalyzeFunction"
*/>}}
Chargement
{{</* jsoneditor
  source="https://raw.githubusercontent.com/json-schema-org/website/main/public/data/getting-started-examples/schemas/default.json"
  postProcessFunction="examplePostProcessFunction"
*/>}}
Chargement
{{</* jsoneditor
  source="https://raw.githubusercontent.com/json-schema-org/website/main/public/data/getting-started-examples/schemas/default.json"
  filenameToDownloadFunction="exampleFilenameToDownloadFunction"
*/>}}
Chargement
{{</* jsoneditor source="jsoneditor/example.json" */>}}
Chargement