json-schema-lookup

SchemaStore を使用した JSON Schema の検索

schemastore.org の公開設定ファイルスキーマのカタログを検索し、構造の検証、オプションの確認、許可されている値のチェックを行います。

API

• カタログ: https://www.schemastore.org/api/json/catalog.json
  • 構造: { "schemas": [{ "name", "description", "fileMatch", "url", "versions"? }] }
• 個別のスキーマ: 該当するカタログエントリーの url を取得します

ワークフロー

1. スキーマを検索する

名前またはファイル名のパターンでカタログを検索します。

# Search by name (case-insensitive)
curl -s https://www.schemastore.org/api/json/catalog.json | jq '.schemas[] | select(.name | test("tsconfig"; "i")) | {name, url, fileMatch}'

# Search by filename match
curl -s https://www.schemastore.org/api/json/catalog.json | jq '.schemas[] | select(.fileMatch[]? | test("package\\.json")) | {name, url}'

または、カタログ URL に対して WebFetch を使用し、該当するエントリーを尋ねます。

2. スキーマを取得して確認する

# List top-level properties
curl -s SCHEMA_URL | jq '.properties | keys'

# Inspect a specific field (type, enum values, description)
curl -s SCHEMA_URL | jq '.properties.FIELD_NAME'

# Check definitions/shared types (schemas use $ref to these)
curl -s SCHEMA_URL | jq '.definitions.DEF_NAME.properties'

# Get the full schema (warning - might be large!)
curl -s SCHEMA_URL | jq .

3. よくあるクエリ

# Find enum values for a field
curl -s SCHEMA_URL | jq '.properties.FIELD.enum'

# List nested properties (e.g. compilerOptions in tsconfig)
curl -s SCHEMA_URL | jq '.definitions.compilerOptionsDefinition.properties.compilerOptions.properties | keys'

# Find all required fields
curl -s SCHEMA_URL | jq '.required'

ヒント

• スキーマによっては allOf／anyOf による合成が使われています。プロパティ一式を確認するには、これらの配列を調べてください
• カタログエントリーの versions フィールドには、利用可能な場合、バージョン固有のスキーマ URL が含まれます
• スキーマ URL はさまざまで、json.schemastore.org を指すものもあれば、raw.githubusercontent.com を指すものもあります
• 大きなスキーマの場合は、ドキュメント全体を出力するのではなく、特定のパスを検索してください
• 1 回のセッション中に複数回検索する場合は、カタログのレスポンスをローカルにキャッシュしてください