API Client の Gem を作った

日頃いろいろな Web API のお世話になっているのですが、API Client の仕組みをきちんと理解したかったので Gem を作成してみました。

法人情報を調べるときにいつも利用している gBizINFO （METI）経済産業省 が Web API を提供していることを知りました。現在 SPARQL と REST の２つのエンドポイントが公開されていますが、今回作成した Gem では REST API のみ対応しています。

gBizINFO REST API の利用には、あらかじめ利用申請を行う必要があります。発行されたアクセストークンを使用します。

つくったもの

• GitHub - ryoma123/gbizinfo-ruby: A Ruby client for gBizINFO APIs.

つかいかた

client = Gbizinfo::Client.new(
  token: 'xxxxxxxxxx'
)

# 法人を検索する
options = { name: '○○株式会社' }
client.hojin_search(options)

# 法人基本情報を取得する
client.hojin(corporate_number: 'xxxxxxxxxxxxx')

作成にあたって、いつも利用している Gem のソースコードを読んで API Client に必要な処理を学んだり、設計を参考にさせてもらいながら実装を進めました。試行錯誤のなかで API Client の仕組みについて理解が進んだのでよかったです。もっと気軽に作成できるように慣れていきたいと思います。