概要

RealWorldプロジェクトのバックエンドAPIをRailsのapiモードで実装した。

目次

• 目次
• 要件
  • ステップ1
  • ステップ2
    • 2-1
    • 2-2
    • 2-3
    • 2-4
    • 2-5 (advanced)
• 実装
  • エンドポイント
  • ユーザー登録
  • ログイン
  • カレントユーザーの取得
  • カレントユーザーの編集
  • アーティクルの作成
  • アーティクルのリストを取得する
  • アーティクルを取得する
  • アーティクルの編集
  • アーティクルの削除
  • アーティクルのお気に入り登録
  • アーティクルのお気に入り解除
• デプロイ
  • デプロイ先
  • インフラ構成図

要件

RealWorld

ブログプラットフォームを作る RealWorld という OSS のプロジェクトがあります。RealWorld は実世界と同じ機能を持つプラットフォームを作ることで、学習したいフレームワークの技術を習得することを目的としてたプロジェクトです。

ここでは、RealWorld の バックエンドの API の仕様を満たす Rails API を作成します。

ステップ1とステップ2に分かれます。時間に余裕がない場合はステップ1に進んでください。時間に余裕がある場合はステップ2に進んでください。ステップ1を終えてからステップ2に進む設計にはなっていないため、最初にどちらに進むかを選択してください。

ステップ1は RealWorld の API の仕様を部分的に満たした API を作成します。具体的には、認証機能のない簡易バージョンの作成になります。

ステップ2は RealWorld の API の仕様を満たす API を作成します。認証機能付きのバージョンの作成になります。

基本的にはステップ2を進めていくことを想定していますが、時間に余裕がない場合はステップ1を進めてください。

RealWorld のドキュメント に目を通した上で、ステップに進んでください。

ステップ1

RealWorld の API のうち、次のエンドポイントを実装してください。

• Create Article
• Get Article
• Update Article
• Delete Article

なお、Article に関わる要素のうち、認証機能及び著者、お気に入り(favorite) は実装しなくてよいものとします。

ステップ2

2-1

RealWorld の API のうち、次のエンドポイントを実装してください。

• Registration

その際に、API spec と呼ばれている Postman のテスト(Conduit.postman_collection.json)の該当する箇所が通るように実装してください(該当箇所以外のテストは削除するとテストしやすいです)。

2-2

次のエンドポイントを実装してください。

• Authentication

その際に、Postman のテストの該当する箇所が通るように実装してください。

2-3

次のエンドポイントを実装してください。

• Create Article
• Get Article
• Update Article
• Delete Article

その際に、Postman のテストの該当する箇所が通るように実装してください。

なお、Article に関わる要素のうち、お気に入り(favorite) は実装しなくてよいものとします。Postman のテストからも該当箇所のコードは削除し除外してください。

2-4

いずれかのエンドポイントのテストを1つ書いてください。

2-5 (advanced)

お気に入り(favorite)も実装してください。

実装

エンドポイント

post   /api/users
post   /api/users/login
get    /api/user
put    /api/user
post   /api/articles
get    /api/articles
get    /api/articles/:slug
put    /api/articles/:slug
delete /api/articles/:slug
post   /api/articles/:slug/favorite
delete /api/articles/:slug/favorite

ユーザー登録

post http://localhost:3000/api/users

リクエストボディ

{
  "user":{
    "username": "Jacob",
    "email": "jake@jake.jake",
    "password": "jakejake"
  }
}

レスポンス

{
  "user": {
    "email": "jake@jake.jake",
    "token": "jwt.token.here",
    "username": "jake",
    "bio": "I work at statefarm",
    "image": null
  }
}

ログイン

post http://localhost:3000/api/users/login

リクエストボディ

{
  "user":{
    "email": "jake@jake.jake",
    "password": "jakejake"
  }
}

レスポンス

{
  "user": {
    "email": "jake@jake.jake",
    "token": "jwt.token.here",
    "username": "jake",
    "bio": "I work at statefarm",
    "image": null
  }
}

カレントユーザーの取得

get http://localhost:3000/api/user

リクエスボディ

nil

レスポンス

{
  "user": {
    "email": "jake@jake.jake",
    "token": "jwt.token.here",
    "username": "jake",
    "bio": "I work at statefarm",
    "image": null
  }
}

カレントユーザーの編集

put http://localhost:3000/api/user

リクエストボディ

{
  "user":{
    "email": "jake@jake.jake",
    "bio": "I like to skateboard",
    "image": "https://i.stack.imgur.com/xHWG8.jpg"
  }
}

レスポンス

{
  "user": {
    "email": "jake@jake.jake",
    "token": "jwt.token.here",
    "username": "jake",
    "bio": "I like to skateboard",
    "image": "https://i.stack.imgur.com/xHWG8.jpg"
  }
}

アーティクルの作成

post http://localhost:3000/api/articles

リクエストボディ

{
  "article": {
    "title": "How to train your dragon",
    "description": "Ever wonder how?",
    "body": "You have to believe",
    "tagList": ["reactjs", "angularjs", "dragons"]
  }
}

レスポンス

{
  "article": {
    "slug": "how-to-train-your-dragon",
    "title": "How to train your dragon",
    "description": "Ever wonder how?",
    "body": "It takes a Jacobian",
    "tagList": ["dragons", "training"],
    "createdAt": "2016-02-18T03:22:56.637Z",
    "updatedAt": "2016-02-18T03:48:35.824Z",
    "favorited": false,
    "favoritesCount": 0,
    "author": {
      "username": "jake",
      "bio": "I work at statefarm",
      "image": "https://i.stack.imgur.com/xHWG8.jpg",
      "following": false
    }
  }
}

アーティクルのリストを取得する

get http://localhost:3000/api/articles

クエリパラメータ

tag, author, favorited, limit and offset

url例

get http://localhost:3000/api/articles?author=jake

レスポンス

{
  "articles":[{
    "slug": "how-to-train-your-dragon",
    "title": "How to train your dragon",
    "description": "Ever wonder how?",
    "body": "It takes a Jacobian",
    "tagList": ["dragons", "training"],
    "createdAt": "2016-02-18T03:22:56.637Z",
    "updatedAt": "2016-02-18T03:48:35.824Z",
    "favorited": false,
    "favoritesCount": 0,
    "author": {
      "username": "jake",
      "bio": "I work at statefarm",
      "image": "https://i.stack.imgur.com/xHWG8.jpg",
      "following": false
    }
  }, {
    "slug": "how-to-train-your-dragon-2",
    "title": "How to train your dragon 2",
    "description": "So toothless",
    "body": "It a dragon",
    "tagList": ["dragons", "training"],
    "createdAt": "2016-02-18T03:22:56.637Z",
    "updatedAt": "2016-02-18T03:48:35.824Z",
    "favorited": false,
    "favoritesCount": 0,
    "author": {
      "username": "jake",
      "bio": "I work at statefarm",
      "image": "https://i.stack.imgur.com/xHWG8.jpg",
      "following": false
    }
  }],
  "articlesCount": 2
}

アーティクルを取得する

get http://localhost:3000/api/articles/:slug

レスポンス

{
  "article": {
    "slug": "how-to-train-your-dragon",
    "title": "How to train your dragon",
    "description": "Ever wonder how?",
    "body": "It takes a Jacobian",
    "tagList": ["dragons", "training"],
    "createdAt": "2016-02-18T03:22:56.637Z",
    "updatedAt": "2016-02-18T03:48:35.824Z",
    "favorited": false,
    "favoritesCount": 0,
    "author": {
      "username": "jake",
      "bio": "I work at statefarm",
      "image": "https://i.stack.imgur.com/xHWG8.jpg",
      "following": false
    }
  }
}

アーティクルの編集

put http://localhost:3000/api/articles/:slug

リクエストボディ

{
  "article": {
    "title": "Did you train your dragon?"
  }
}

レスポンス

{
  "article": {
    "slug": "how-to-train-your-dragon",
    "title": "How to train your dragon",
    "description": "Ever wonder how?",
    "body": "It takes a Jacobian",
    "tagList": ["dragons", "training"],
    "createdAt": "2016-02-18T03:22:56.637Z",
    "updatedAt": "2016-02-18T03:48:35.824Z",
    "favorited": false,
    "favoritesCount": 0,
    "author": {
      "username": "jake",
      "bio": "I work at statefarm",
      "image": "https://i.stack.imgur.com/xHWG8.jpg",
      "following": false
    }
  }
}

アーティクルの削除

delete http://localhost:3000/api/articles/:slug

レスポンス

レスポンスなし

アーティクルのお気に入り登録

post http://localhost:3000/api/articles/:slug/favorite

レスポンス

{
  "article": {
    "slug": "how-to-train-your-dragon",
    "title": "How to train your dragon",
    "description": "Ever wonder how?",
    "body": "It takes a Jacobian",
    "tagList": ["dragons", "training"],
    "createdAt": "2016-02-18T03:22:56.637Z",
    "updatedAt": "2016-02-18T03:48:35.824Z",
    "favorited": false,
    "favoritesCount": 0,
    "author": {
      "username": "jake",
      "bio": "I work at statefarm",
      "image": "https://i.stack.imgur.com/xHWG8.jpg",
      "following": false
    }
  }
}

アーティクルのお気に入り解除

delete http://localhost:3000/api/articles/:slug/favorite

レスポンス

レスポンスなし

デプロイ

デプロイ先

https://www.coderpanda.net

インフラ構成図