如何为现有的rails应用程序构建版本API？

Question

如何为现有的rails应用程序构建版本API？ 我已经建立了与用户的关系，船舶和公司

Company has_many users 

User belongs_to company 

一个简单的应用程序如何建立一个版本API为这个应用程序

Answer 1

原料药

这里的目录结构，ApiController是ApplicationController的子类，并充当所有其他API控制器的父类。

app/controllers/ 
    . 
    |-- api 
    | `-- v1 
    |  |-- api_controller.rb 
    |  |-- users_controller.rb 
      |-- companies_controller.rb 
    |-- application_controller.rb 

这里是控制器的样子：

应用程序/控制器/ API/V1/api_controller.rb

module Api::V1 
    class ApiController < ApplicationController 
    #API stuff here 
    end 
end 

应用程序/控制器/ API/V1/users_controller.rb

module Api::V1 
    class UsersController < ApiController 

    # POST /v1/users 
    def create 
     your code goes here 
    end 

    end 
end 

API路线

routes.rb 

    namespace :api, defaults: {format: :json} do 
     namespace :v1 do 
     resources :users 
     end 
    end 

用户的index action API的网址，只需例如

http://localhost:3000/api/v1/users.json