Help us understand the problem. What is going on with this article?

PhoenixFrameworkでREST APIを作ってみよう

More than 3 years have passed since last update.

PhoenixFrameworkでは簡単にREST APIを作成することが出来ます。
簡単なやり方ですが、一つ間違えばmix testで盛大にコケるので、備忘録として書いておきます。

やり方

Phoenixのプロジェクト作成から順にやっていきます。

$ mix phoenix.new test_api
$ mix ecto.create
$ mix phoenix.gen.json Hoge hoge name:string

次にweb/router.exを編集しましょう。

router.ex
  # Other scopes may use custom stacks.
  # ↓のコードはデフォルトでコメントアウトになっているので外しましょう
  scope "/api", TestApi do
    pipe_through :api
    resources "/hoge", HogeController, except: [:new, :edit] # 追加
  end 

最後にmigrateをしてからmix testしてみましょう。

$ mix ecto:migrate
$ mix test

これでテストがコケなければOKです。

ここから更に、/api/v1/hogeなどAPIのバージョニングする時は以下の記事が参考になります。
Phoenix でバージョニングした REST API を構築する
(Thanks for WAKASUGI!)

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away