如何在 rails 5 中创建 API？

Question

我是 Web 服务的新手，Rails 也是。我对使用 rails 创建 API 有疑问 5. 如何为 rails 5 应用程序创建 API？我可以找到一些教程 API only applications using rails 5. 但我需要 API 和单个 rails 中的视图5 应用。我该怎么做？

Answer 1

您可以像往常一样创建一个新的 rails 项目：

$ rails new my_project
$ cd my_project
$ bundle

然后你可以使用scaffold生成一些代码：

$ rails g scaffold Product name:string price:float

并迁移您的数据库：

$ rails db:migrate # => update the database

您现在可以查看 app/controllers/products_controller.rb

class ProductsController < ApplicationController
  before_action :set_product, only: [:show, :edit, :update, :destroy]

  # GET /products
  # GET /products.json
  def index
    @products = Product.all
  end

  # GET /products/1
  # GET /products/1.json
  def show
  end

  # GET /products/new
  def new
    @product = Product.new
  end

  # GET /products/1/edit
  def edit
  end

  # POST /products
  # POST /products.json
  def create
    @product = Product.new(product_params)

    respond_to do |format|
      if @product.save
        format.html { redirect_to @product, notice: 'Product was successfully created.' }
        format.json { render :show, status: :created, location: @product }
      else
        format.html { render :new }
        format.json { render json: @product.errors, status: :unprocessable_entity }
      end
    end
  end

  # PATCH/PUT /products/1
  # PATCH/PUT /products/1.json
  def update
    respond_to do |format|
      if @product.update(product_params)
        format.html { redirect_to @product, notice: 'Product was successfully updated.' }
        format.json { render :show, status: :ok, location: @product }
      else
        format.html { render :edit }
        format.json { render json: @product.errors, status: :unprocessable_entity }
      end
    end
  end

  # DELETE /products/1
  # DELETE /products/1.json
  def destroy
    @product.destroy
    respond_to do |format|
      format.html { redirect_to products_url, notice: 'Product was successfully destroyed.' }
      format.json { head :no_content }
    end
  end

  private
    # Use callbacks to share common setup or constraints between actions.
    def set_product
      @product = Product.find(params[:id])
    end

    # Never trust parameters from the scary internet, only allow the white list through.
    def product_params
      params.require(:product).permit(:name, :price)
    end
end

如您所见，create 操作中有 respond_to。这就是您响应不同请求类型的方式。

了解更多信息：http://edgeapi.rubyonrails.org/classes/ActionController/MimeResponds.html#method-i-respond_to

Answer 2

我有自己的解决方案，可以非常快速地 API 构建 https://github.com/igorkasyanchuk/fake_api 至少在原型设计阶段。

使用这个 gem 我能够为前端团队提供 API 的骨架，后来它被更改为常规 rails 控制器。

Answer 3

在创建 RESTful API 时，根据 Rails 5 发行说明，仅生成 API 应用程序将：

使用一组有限的中间件启动应用程序
使 ApplicationController 继承自 ActionController::API 而不是 ActionController::Base
跳过视图文件的生成，

我正在列出文章/博客 post 的 link 阅读那些：

阅读以上任何一篇博客，并浏览其他博客以获取更多详细信息或出于知识目的

祝你编码愉快！ ‍‍

Answer 4

只需构建您的常规 rails 应用程序，当您需要该方法的 API 行为时，只需使用 json 响应

def index
    @cards = Card.all
    render json: { status: 'Success', message: 'Loaded all cards', data: @cards }, status: :ok
end

如果你真的需要控制器的额外行为，你可以只需要一个常规控制器并将继承更改为这样的东西

class CardsController < ActionController::API
    #your code
end

有关此具体检查的更多信息Rails API Applications

如何在 rails 5 中创建 API？

How to create API in rails 5?

web-services

ruby-on-rails

ruby-on-rails-5