namespace のブロックの中で mount すればよい。 version に twitter/v1 のようなパスを書いても同じ URL が得られるが、 routes を表示したときに :version にまとめられてしまってわかりづらいので明示的に namespace を切ったほうがよい。 require 'grape' module Twitter module API class V1 < Grape::API version 'v1' format :json end end end module Twitter module API class V1 < Grape::API class Users < Grape::API get '/users' do { users: 1 } end end end end end module Twitter module API c
app以下にAPI用のディレクトリを作成する Rails newで作られたフォルダとは別にapp/下にapi/を用意。 自動で/apiを読み込むようにapplication.rbに2行を追加する。 module RailsSample class Application < Rails::Application # 省略 config.paths.add File.join('app', 'api'), glob: File.join('**', '*.rb'), eager_load: true config.autoload_paths += Dir[Rails.root.join('app', 'api', '**', '*.rb')] end end
はじめに Grapeは、RubyでRESTful APIを簡単に作成するためのフレームワークです。 この記事では、「Grape」と「grape-entity」を使ってAPIを簡単に作成する方法をサクッとご紹介します。 ※Grape導入のため、モデルの作成、データの作成、テスト部分は省略します。以下の記事でモデルの作成、データの作成、テストの導入部分を記述しています。参考程度に読んでみて下さい。 実行環境 M2 mac mini Rails 7.1.3 Ruby 3.2.3 Mysql 8.0 Docker 25.0.2 vscodeエディタ 環境構築が済んでいない方はこちらを参考に環境構築を行なってください。 Schemafileの導入がまだの方はこちらから設定してください。 RSpecの導入 ※こちらは導入しなくてもOKです。 Grape、corsをgemファイルに追加
概要 Railsで作成されたAPIのテストについてこちらを参考に必要最低限の情報をまとめました。 実際にこちらの記事で作成したAPIに対してテストを書いていきます。 何をテストする？ 適切なAPIはHTTPのレスポンスのステータスコードと実際のデータを含んだレスポンスボディを返します。 よって主にその２つをテストしていきます。 ステータスコード 通常APIによって返されるステータスコードは以下の４つに分類されます。 APIの動きによってこちらのコードと照らし合わせる事でテストします。 200: OK - リクエストは成功し、レスポンスとともに要求に応じた情報が返される。 401: Unauthorized - 認証失敗。認証が必要である。 403: Forbidden - 禁止されている。リソースにアクセスすることを拒否された。 404: Not Found - 未検出。リソースが見つから
2020.10.01に公開 2020.10.09に更新 Udemy 12. サーバーサイドのログイン認証 No.4 / 8 今回達成すること JWT（以下、トークン）を検証し、正しければ発行主のユーザーを返すAuthenticatorモジュールを作成します。 モジュールで作成したメソッドは、Railsコントローラーのbefore_actionで読み込みます。 これにより、ログインユーザーしかアクセスできないコントローラーアクションを作成することができます。 モジュールファイルを作成する モジュールファイルは、前回作成した「services/user_auth」ディレクトリ内に作成します。 authenticator.rbを作成しましょう。 root $ touch api/app/services/user_auth/authenticator.rb UserAuthを継承したモジュールを
2020.10.01に公開 2021.06.09に更新 Udemy 12. サーバーサイドのログイン認証 No.2 / 8 今回達成すること 今回は、ログイン認証の流れを理解し、JWTの実装に入ります。 JWTの初期設定ファイルを作成するところまでをゴールとしましょう。 ログイン認証機能の参考 ここで紹介するログイン機能は、RailsAPIでJWT認証が実装できるGem knockを参考にしています。 Knockは2016年から更新が止まっており、Rails6には対応しなくなりました。（非公式版は2020年も更新あり） そこで今回は、Knockのコードを参考に1からログイン認証を手作りします。 JWTを使ったログイン認証の流れ 今回実装するログイン認証では、以下の手順で認証が行われます。 1. クライアントからログイン情報を投げる まず初めにNuxt.jsからログインに必要な メールアドレ
解決する課題 従来のWebアプリケーションでは、認証情報をCookiesを利用して保持し、ログイン状態を保つことを実現しています。 APIではブラウザを介さないことからCookiesを使用したセッションの保持は行えないため、認証時に生成したトークンを用いて認証済み（ログイン状態）であることを表現できます。 JSON Web Tokenの利用 認証時に生成するトークンは慣例通りJSON Web Token（JWT)を利用します。 Railsでは"jwt"というGemがあるので、簡単に扱うことができます。 アプリケーションによりますが、controller/concernsに認証用モジュールを設け、そこにJWT関連の処理をまとめて記載すると扱いやすいです。 暗号化・復号化の実装 手始めに、暗号化・復号化の実装例は下記のようになります。 app/controller/concerns下に作成して
背景 以前、vue.js × Rails APIでのSPA開発に挑戦しました。その際、認証にJWTを使ったのですが、ネットの記事を参考に実装したために仕組みやコードを完全に理解できていませんでした。そのためJWTの認証について改めて記事にしてまとめたいと思いました。railsでvue,reactなどと連携させてSPA開発したい方は参考になるかと思います。 #目次 JWTについて JWTで認証をする流れ 実際のrailsコード解説 vue.jsとの連携 1. JWTについて ###■JWTとはなにか JWTとはJSON Web Tokenの略で、JSON形式で表されたトークンです。著名・暗号化によってセキュアな通信ができます。 ###■JWTの中身 JWTは下記のうようにピリオド区切りで３つの要素に分かれています。 ①のヘッダー要素は、データの型やルールを指定します。 ②のペイロード要素には
concernとは app/concernsというディレクトリが存在する。concernsは ・複数のコントローラー（モデル）から利用される処理を共通化する目的 ・ある特定のまとまった処理を切り出して見通しをよくする目的 上記の目的で使われることが多い。 Concernの書き方 まずはconcernのファイルを記入し、その後コントローラーにてincludeで表記する。 module MyConcern extend ActiveSupport::Concern # Scope や Callbackなどの処理を実装する included do scope :without_deleted, lambda{ where(deleted_at: nil) } end module ClassMethods def foo puts 'foo' end end def bar puts 'bar'
Railsアプリケーションの例外ハンドリングとエラーページの表示方法については色々な方法があると思いますが、そのなかでもよく使われる方法についてまとめてみました。 前提 Rails 4.2.6 Rails 標準の仕組みで静的ページを表示する Rails は標準では Rack Middleware のActionDispatch::ShowExceptionsの仕組みで例外を捕捉して、エラーページを表示しています。その際、捕捉した例外に対してどんなエラーページを表示するのかをActionDispatch::PublicExceptionsが処理しています。 例えばActionController::RoutingErrorが発生した場合、対応する404のHTMLファイルpublic/404.htmlが表示される、という感じです。 なお、rails generateしたときに用意されるHTML
Rails で例外を発生させたい際は，raise...つまり RuntimeError をよく使用するかと思います。 しかし，サービス上の制約から，特定の状況下で例外を発生させる場合，raiseだけでは物足りなくなる時があります。 raiseでは「何かまずいことが起きてしまいました！」程度のことしか伝えてくれません。まぁ，引数に渡す message を見れば理解できるかもですが... 兎にも角にも，特定の状況下に対する例外が存在するなら，その例外に対して名前を付けてあげましょう。 カスタム例外を設定すると，発生時に「何に対する例外か」がパッと理解できるようになりますし，特定の動作に誘導することも容易になりますので，良いことづくめです！ 参考 URL 等 項目22 | Effective Ruby（長尾高弘 arton PeterJ.Jones）｜翔泳社の本 Railsアプリケーションにおけ
はじめましてこんにちは。 夏が本気を出してきて最近麺類しか口にしていないサーバサイドエンジニアのかしまです。 この度APIにてHTTP Status Codeとは別に、例外に対応するエラーコードを返すよう奮闘したのでその知見を共有したいと思います。 やりたいこと APIにて例外が発生した場合、以下の形式でレスポンスを返すようにします。 { "errors": [ { "code": "code1", "message": "message1", }, { "code": "code2", "message": "message2", }, ] } Why？ 今回追加したAPIは外部のアプリケーションとの連携に使うため、以下の要件を満たす必要がありました。 クライアントサイドがハンドリングしやすいような設計にする エラーの識別子は不変であること そのためエラーメッセージとは別に、コードを返す
はじめに RailsのAPIでエラー処理ってどうすればいいんだろう？ どんなJSONを返せばいいんだろう？ 筆者が関わっている企業でよくこのように悩んでる人を見かけるので、自分の経験を基に記事にまとめてみました。 返すべきJSONの形 ぶっちゃけ、企業によってまちまちですし、「これが絶対正解だ！」と言えるものはありません。 いろんな企業のAPIがどのような形のレスポンスを返しているか知りたければ、WebAPIでエラーをどう表現すべき？15のサービスを調査してみたという記事が非常に参考になります。 ただ、上記の記事にも書いてありますが、2016年に出たRFC7807が、「こういう形でいいんじゃね！？」っていう標準となるようなJSONの形を提案してくれています。 RFC7807が提案する形 詳しくはRFCの方を参照していただければと思いますが、具体例を書くとこんな感じです。 { "type":
class ApplicationController < ActionController::Base # Prevent CSRF attacks by raising an exception. # For APIs, you may want to use :null_session instead. protect_from_forgery with: :exception # 他のエラーハンドリングでキャッチできなかった場合に # 500 Internal Server Error(システムエラー)を発生させる # NOTE: rescue_from は下から評価されるので記載箇所はここが正解 rescue_from Exception, with: :handle_500 unless Rails.env.development? # 例外に合わせたエラーハンドリング # 4
RailsでAPIを雑に書いていたんだけど, コントローラとかをどう書くとエラー処理しやすくなっていいかなーと考えていて, 個人的に考えがまとまったのでブログ書いた. ※9/1に追記書いた. 良いエラー処理について 個人的にAPIを書く上で(API書くに限らない気はするけど)どういうふうにエラー処理を行うと良いかなーと考えてみると コントローラ内では基本的に, ある関数の処理が失敗して, 次の処理が行えない場合はすべて例外を投げる 例外は各々のコントローラ内で例外のキャッチは行わず, すべてApplicationControllerなど, 親コントローラ内の1メソッドで完結させる かなーと思う. APIのエラー処理は, Envelopeにステータスコードとエラーメッセージを書いて, APIのフォーマットを統一するほうがクライアントが作りやすそうだし, またこのように処理することで, エラー
ruby-jwtのエンコードメソッドについて ruby-jwtのエンコードメソッドであるJWT.encodeの引数の意味は以下の通りです。 たとえば第3引数にRS256（SHA-256アルゴリズムを利用したRSA）を指定した場合、第2引数にはRSA暗号の秘密鍵をセットします。 第3引数にnone（署名やMAC値を利用しない）を指定した場合、noneではパスワードが不要なため第2引数にはnilをセットします。 なおアルゴリズムの動的な選択は脆弱性につながるため、第3引数はハードコードで記述することが推奨されています。1 ruby-jwtのデコードメソッドについて ruby-jwtのデコードメソッドであるJWT.decodeの引数の意味は以下の通りです。 たとえばRS256アルゴリズムを利用したJWTをデコードする場合、第2引数にはRSA暗号の公開鍵（あるいは秘密鍵）を指定し、第4引数には{
JWTはtokenというキー名でCookieに保存する JWTの署名アルゴリズムはRSA256を利用する JWTのエンコードでは事前に作成したRSA暗号の秘密鍵を利用する JWTにはユーザーIDを保存する JWTの有効期限は14日とする 下準備 ユーザーの作成 認証対象のユーザーを作成します。ActiveModel::SecurePassword::ClassMethodsのドキュメントに従い、has_secure_passwordでパスワード管理されたデータを作成します。 Gemfile gem "bcrypt" ### モデルのマイグレーション $ rails g model user name email password_digest $ rails db:migrate user.rb class User < ActiveRecord::Base has_secure_pass
はじめに 通常はcontrollers/以下に作成されてしまうコントローラーを、特定のディレクトリ以下に作成するコマンドです。 環境
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
WebAPI で multipart/form-data を使う
