Rails の取り扱い説明書、それが Ruby on Rails API
みなさんこんにちは！
突然ですが、あなたは Ruby on Rails API を知っていますか？
「API」というのは「プログラムの取り扱い説明書」のことです。
なので、「Ruby on Rails API」は「Railsの取り扱い説明書」のことを表します。もっと簡単に言えば、Railsの公式ドキュメントです。
ある程度 Rails を使っている人なら、みんな知っているレベルのものですが、ちゃんと紹介している記事が意外と見当たらなかったので、紹介記事を書いてみることにしました。
Ruby on Rails API に書いてあること
Rails が独自に定義している、クラスやメソッド（例えば ActionController::Base や link_to など）について、以下のような情報を得ることができます。
- 概要（何をするためのものか？）
- メソッドの引数や戻り値
- サンプルコード
- 使用上の注意点
例えば、default_scope というメソッドを API で検索した場合、以下の情報が表示されます。
- モデルに対して、デフォルトの検索条件を設定できる
- モデル内で
default_scope { where(published: true) }のように記述する - レコードの新規作成時のデフォルト値にも影響を与える
といったことが書いてあります。サンプルコードなども記述されていて、とても分かりやすいですね。
Ruby on Rails API の使い方
使い方はとても簡単です。
http://api.rubyonrails.org にアクセスし、
- 左上の検索フォームに、メソッド名やクラス名を入力します。
- 左下に候補が表示されるので、詳しく見たいものを選択します。
- 右側に、メソッドまたはクラスの詳細が表示されます。
実際に使って見ると分かりますが、レスポンスが非常に早く、とても快適です。
過去バージョンの API も見れる！
http://api.rubyonrails.org には、常に最新バージョンの API が表示されます。
記事執筆時点では Rails 5.2.1 です。
でも、実際の開発では、常に最新バージョンの Rails が使えるわけじゃないですよね。旧バージョンの API を見ることはできないのでしょうか？ ええ、もちろん見れます。
http://api.rubyonrails.org/v4.2.9 のように、URL の末尾に v + バージョン番号 をつければ良いんです！
自分のプロジェクトで使っているバージョンのURLを、ブックマークに登録しておくと便利です。
まとめ
- Ruby on Rails API とは、Railsの取り扱い説明書である。
- メソッド名やクラス名から検索できる。
- 過去バージョンの情報を見ることもできる。
おまけ
Source: show | on GitHub のリンクから、気軽にソースコードを確認できるので、暇な時にやってみてください。
名前の付け方や、メソッドの分け方、コメントの使い方など、とても勉強になります。
また、Railsが内部でどんな処理をしているのか理解することで、デバッグなどにも活かせます。
