【Rails】シリアライザーに対応するTypeScriptの型を生成する方法

Typelizerを使用するとシリアライザーに対応するTypeScriptの型を生成できます。

インストール

Gemfileに以下を追記します。

Gemfile

gem "typelizer"

bundle installを実行します。

bundle install

使い方

Albaを使用している場合にはapplication_resource.rbにinclude Typelizer::DSLを追記します。

app/resources/application_resource.rb

class ApplicationResource
  include Alba::Resource
  include Typelizer::DSL
end

ターミナルで以下のコマンドを実行すると型定義ファイルが生成されます。
デフォルトではapp/javascript/types/serializersに生成されます。

rails typelizer:generate