Rails webAPIを作りたい！

Rails5.0を使って「郵便番号-住所検索API(http://zipaddress.net)」のようなWebAPIサーバを作りたいです。
今はiOSアプリケーションを使って、このAPIに郵便番号のリクエストを送って、住所を引き出すことはできています。

このAPIの作り方をどなたか教えていただけませんか？
よろしくお願いしますよろしくお願いします。

開発環境
Ubuntu上で開発をしています。
・Ruby 2.3
・Rails 5
・PostgreSQLを使用

行動規範の内容に同意します

回答1件

ベストアンサー

Railsの基本的な知識があれば、APIを作ること自体は簡単ですので、
おそらく郵便番号のデータをどうやって手に入れるのかが分からないのだろうと推測します。

郵便局が公式と考えて間違いないでしょうからここからダウンロードします。
http://www.post.japanpost.jp/zipcode/download.html

CSVの形式を見た上で、どんなテーブルにすれば良いか考えて、モデルとテーブルを作って、
CSVの内容をDBへ登録するバッチを書いて実行する。
次にAPIのパラメータと対応するレスポンスを考えて、APIコントローラを作成する。

という感じで作れます。

APIのシンプルな例

APIというのは特別なものではなくて、単にJSONを出力するアクションの事です。
ものすごくシンプルにすると、こういうやつです。
拡張子も別に.jsonにする必要もありません。好みの問題です。

ruby
1# routes.rb
2Rails.application.routes.draw do
3   get 'sample/test', to: 'sample#test'
4end
5
6# app/controllers/sample_controller.rb
7class SampleController < ApplicationController
8   def test
9      # 配列かハッシュ
10      data = [
11          {id: 1, name: "アイテム1"},
12          {id: 2, name: "アイテム2"}
13      ]
14 
15      render json: data
16   end 
17end

この例では、ブラウザで
http://railsのIPアドレス:ポート番号/sample/test にアクセスすると

json
1[{"id":1,"name":"アイテム1"},{"id":2,"name":"アイテム2"}]

というJSONが表示されれば成功です。

投稿2016/12/18 10:42

編集2016/12/19 02:36

mingos

総合スコア4025

YUKImidaifucu

2016/12/19 02:17

回答ありがとうございます。わかりづらい説明、失礼しました… 郵便番号データありがとうございます。実はAPIを作ることにも苦戦しています… APIを作ることは、こちらのサイトのように進めればできるのでしょうか？（http://ruby-rails.hatenadiary.com/entry/20150108/1420675366）今、JSON関連のエラーが発生してしまいました。（undefined local variable or method 'son' for main : Object Did you mean? JSON）また、調べてみてもイマイチAPI作成ができたことをどうやって確認するのかがわからないです。