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

Question

如何为现有的 Rails 应用构建版本 API？ 我已经建立了一个简单的应用程序与用户和公司的关系

Company has_many users

User belongs_to company

我怎样才能为这个应用构建一个版本化 api

Answer 1

API 的目录结构

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

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

以下是控制器的外观：

app/controllers/api/v1/api_controller.rb

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

app/controllers/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

用户索引操作的API URL，只是示例

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