JSON Schemaの備忘録

JSON Schemaとは

Json Schema organization によって開発・保守されているスキーマ言語で、JSONデータの構造をJSONそのもので定義するためのもの。簡単にいうと、JSON File作るとき、やりやすくなるためのもの

JSON Schema Definition 入手方法

JSON Schema StoreかGitHubがメインの入手方法になります。もちろん自分で作ってもよい。

• JSON Schema Store
• GitHub Action
  • https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/github-action.json
• GitHub Workflow
  • https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/github-workflow.json
• CloudFormation
  • https://raw.githubusercontent.com/awslabs/goformation/master/schema/cloudformation.schema.json
• SAM
  • https://raw.githubusercontent.com/awslabs/serverless-application-model/master/samtranslator/validator/sam_schema/schema.json
• Docker
  • https://github.com/docker/compose/tree/master/compose/config
    • config_schema_v3.0.json
    • config_schema_v3.1.json
    • config_schema_v3.2.json
    • config_schema_v3.3.json
    • config_schema_v3.4.json
    • config_schema_v3.5.json
    • config_schema_v3.6.json
    • config_schema_v3.7.json
• Kubernetes
  • https://github.com/garethr/kubernetes-json-schema
  • v1.5.0 ~ v1.14.0 まで、たくさんあります

JSON Schemaの使い方

Visual Studio Codeの場合、YAML Pluginをインストールすれば、すぐ使えます。

設定の書き方

podから始まるのyml,yamlファイルが下記のJSON Schemaが適用されます。

Settings.json

{
  "yaml.schemas": {
    "https://raw.githubusercontent.com/garethr/kubernetes-json-schema/master/v1.13.0/pod.json": [
      "pod*.yml",
      "pod*.yaml"
    ]
  }
}

使うイメージ

左上はファイル名、Ctrl + Spaceで左下のように、設定できる項目が表示され、選択される項目は、右に説明も表示されます。