使用Rails开发平台以后,很多时候都需要给前端或者一些别的什么地方提供一些数据接口,这里我们就来介绍一下如何入门Rails接口。
目录文件
一般情况下,interface的目录都会这样设置
+app
+controllers
+interfaces
+your_interface_controllers.rb
命名
.rb文件的命名是有规则的,以user 为例。我们要写一个user的接口文件来传递准备好的数据,所有按照命名规则,文件命名为users_controller.rb。
接口文件的结构内容
#users_controller.rb
class Interface::CasesController < ActionController::Base
#声明一个继承自ActionController::Base的类
def all_users
#定义一个action来返回所有的user数据中的id,name字段
all_users = User.all.map do |user|
{
:id = user.id,
:name = user.name
}
end
render :json => {:result => all_users}
end
end
以上就完成一个最简单的接口文件,其中定义一个接口叫做all_users,然后我们在routes.rb文件中配置好路由。打开routes.rb,插入如下代码:
namespace :interface do
resource :user, :only => [] do
collection do
get :all_users
end
end
end
这样在路由文件中配置好了all_users的路由