json架构目录的Linter

Question

我的团队构建了一个API，所有的输入和输出都使用JSON Schema来验证数据，这个项目正在增长，昨天我检测到我们已经有85个JSON文件，每个文件上都有一个JSON模式来验证某些东西，我还检测到我要对每个文件做很多重构，例如，应该提取许多重复的代码，并将其作为单个模式并在每个文件上引用此模式。所以我尝试用google搜索一个库来扫描这个目录，并帮助我检测这种错误，还有一个JSON schema linter，它可以帮助我检测其他错误，但我什么也找不到。所以我发布这个问题是想知道是否有人也有同样的问题，并找到了一些解决它的工具。

Answer 1

对于我现在正在工作的项目，我们正在使用tv4来验证JSON Schema文件，而不是“linting”本身，但应该是您正在寻找的。

Answer 2

我以前从未使用过这个库，但这里有一个您可以做的示例。在这里，库本身不是重要的部分。

下载http://json-schema.org/draft-04/schema并将其另存为draft04-metaschema.json (或用于模式的任何元模式)。使用npm中的ajv-cli：

npm install -g ajv-cli
ajv validate -s draft04-metaschema.json -d your-schema.json

这将根据指定的元模式验证您的模式，以确保它是有效的。您可以使用相同的方法来验证您的模式，方法是使用您希望使用的任何其他库。希望这足以让你入门。

Answer 3

我还必须找到一种验证模式的方法。ajv validate -s draft06-metaschema.json -d your-schema.json只检查基本的东西(例如，它不检查$ref的值和正则表达式)。ajv compile -s your-schema.json会检查更多内容并打印错误消息(如error: Invalid regular expression: /^(\d|[12]\d|3[01]$/: Unterminated group)。

因此，我使用以下脚本(validate_schema.sh)：

#!/bin/bash

set -ex

[ $# = 3 ]
url_draft=$1
json_draft=$2
json_target=$3

jq -e '.["$schema"]=="'"$url_draft"'"' "$json_target"

# False positives are possible though:
ajv validate -s "$json_draft" -d "$json_target"

ajv compile -s "$json_target"