kokudokoutsu-api
v1.0.0
Published
国土交通省のGraphQLから取れるデータの中で自分が最もよく使うであろう都道府県と市町村のデータのクラスにしました。
Downloads
2
Readme
国土交通省GraphQL APIの都道府県と市町村クラス
国土交通省のGraphQLから取れるデータの中で自分が最もよく使うであろう都道府県と市町村のデータのクラスにしました。
I created classes for prefecture and municipality data, which I believe I will use most frequently among the data available from the Ministry of Land, Infrastructure, Transport and Tourism's GraphQL.
How to Use
国土交通省データプラットフォームでアカウントを作成して、APIキーとIDを取得する。
APIキーとIDを取得した後、yarn, npm などでインストールします
yarn add kokudokoutsu-api
or
npm install kokudokoutsu-api
- クラスメソッド使い方
const koutsu = new KokudoKoutsuAPI({
apiId: YOUR_API_ID
apiKey: YOUR_API_KEY
})
/** example data
[ ...
{
code: 45,
code_as_string: '45',
name: '宮崎県',
name_short: '宮崎',
hiragana: 'みやざき',
romaji: 'miyazaki',
used_until: null
},
...
]
**/
const prefectureList = await koutsu.getPrefectures()
// 北海道、青森、岩手のコードをリストでリターンします
const prefectureCodeList = await koutsu.getPrefectureCodes(['hokkaido' |'aomori' |'iwate'])
// 全部の都道府県のコードをリストでリターンします
const prefectureCodeList = await koutsu.getPrefectureCodes([])
// 北海道、青森、岩手の市町村データをリストでリターンします
const munis = await koutsu.getMunicipalitiesByPrefecture(prefectureCodeList)