Rails API 만들기 (feat. Postman 사용)

개요

API 라는 단어는 익숙하고 만들어진 API를 수정해본 적은 있으나 생각해보니 처음부터 만들어본 적이 없었다.

테스트 환경도 전부 세팅 되어있던 것들을 통해 진행하다보니, 간단한 것이라도 처음부터 만들어보고자 해서 포스팅을 해보게 되었다.

 

가장 기본적인 게시글 작성(post create)을 API 형태로 만들고 이를 postman을 통해 테스트를 해보고자 한다.

 

---

API 작성

 

Rails 프로젝트를 하나 만든다.

rails new 프로젝트명
bundle install

 

기본적인 Model과 Controller 생성해준다. 그리고 당연히 migrate도 해준다.

rails g model Post title:string content:string user_id:integer
rails g model User name:string
rails g controller Posts
rake db:migrate 

간단한 관계 설정도 명시해준다.

# app/models/user.rb
class User < ApplicationRecord
  has_many :posts
end
 
# app/models/post.rb
class Post < ApplicationRecord
  belongs_to :user
end
 

# app/controllers/posts_controller.rb
class PostsController < ApplicationController
  def create
    post = Post.new(post_params)
    post.user = default_user
    post.save! # save vs save!(rails Exception)
render json: post.to_json
  end
 
 
  private
  def post_params
    params.require(:post).permit(:title, :content)
  end
end

콘솔 통해서 데이터 확인.

---

참고

• dev.to/caicindy87/rendering-json-in-a-rails-api-25fd
• edgeguides.rubyonrails.org/active_record_migrations.html
• kbs4674.tistory.com/180
• guides.rubyonrails.org/routing.html

 

참고로 중간에 컬럼 추가 및 삭제를 하다가 명령어 오타를 냈다가 찾아보게 됐는데 컬럼 추가 및 삭제는 아래와 같은 규칙을 가지고 있다. :index 옵션을 주면 index  추가도 가능

rails generate migration add_fieldname_to_tablename fieldname:string
rails g migration add_field_to_table field:type:index
rails generate migration remove_fieldname_to_tablename fieldname:string