GraphQL API

PLATEAU データカタログ API は GraphQL ベースで提供されており、必要な情報を 1 リクエストで柔軟に取得できます。

エンドポイント

https://api.plateauview.mlit.go.jp/datacatalog/graphql

ブラウザで上記 URL を開くと、組み込みの GraphiQL が起動し、対話的にクエリを試せます。

ドキュメント

スキーマリファレンス全ての Query / Object / Input / Enum 型の自動生成リファレンス

プレイグラウンドブラウザ上で GraphQL クエリを実行できる対話環境

クエリ例

query {
  area(code: "13101") {
    id
    type
    datasets {
      id
      name
      items {
        id
        name
        url
      }
    }
  }
}

curl -X POST https://api.plateauview.mlit.go.jp/datacatalog/graphql \
  -H 'Content-Type: application/json' \
  --data '{"query":"{ area(code: \"13101\") { datasets { name items { url } } } }"}'

スキーマ

スキーマ定義（SDL）は plateauapi (GitHub) のソースコードから生成されており、本ドキュメントのスキーマリファレンスも同じ introspection から自動生成されています。