Правильный способ реализации контроля версий API с помощью active_model_serializers

Я знаю, что уже есть некоторые вопросы, а такжеэто открытая проблема, связанная с тем, что AMS не обрабатывает пространства имен слишком эффективно (который используется этим подходом к управлению версиями), но я хотел быть уверенным, что нахожусь на правильном пути в рамках текущих ограничений.

Сейчас я использую Rails 5 и AMS 0.10.1, поэтому я сделал следующее:

# config/initializers/active_model_serializer.rb
ActiveModelSerializers.config.serializer_lookup_enabled = false

отключить поиск сериализатора по умолчанию (который все равно не работал); а также

# app/controllers/application_controller.rb
class ApplicationController < ActionController::API
  def get_serializer(resource, options = {})
    unless options[:each_serializer] || options[:serializer] then
      serializer = (self.class.name.gsub("Controller","").singularize + "Serializer").constantize
      resource.respond_to?(:to_ary) ? options[:each_serializer] = serializer : options[:serializer] = serializer
    end
    super(resource, options)
  end
end

переопределить, как сериализаторы найдены по умолчанию; мои контроллеры и сериализатор такие:

# app/controllers/api/v2/api_controller.rb
module Api::V2
  class ApiController < ApplicationController
    ...

# app/controllers/api/v2/users_controller.rb
module Api::V2
  class UsersController < ApiController
    ...

а также

# app/serializers/api/v2/user_serializer.rb
module Api::V2
  class UserSerializer < ActiveModel::Serializer
    ...    

Теперь такие вещи, какActiveModel::Serializer.serializer_for(object) не будет работать, поэтому я должен был также пропатчить мои спецификации запросов, используяexample.metadata[:api_version] установить версию API перед каждым тестом и поднятием и ошибкой, если пример не установил ее.

Так:

Есть ли лучший способ документирования?Это близко к тому, чтобы быть правильным?Буду ли я сталкиваться с проблемой в дальнейшем с этим подходом?как это может быть улучшено?

Ответы на вопрос(2)

Решение Вопроса

ни документированного, ни где-либо, он также кажется правильным, и через некоторое время я не сталкивался с проблемами при его использовании, это хороший подход для управления версиями API.

В любом случае, я советую осторожно использовать этот подход, чтобы не изменять поведение старых поддерживаемых версий для вашего API. Тщательно протестируйте и оповестите своих клиентов об устаревании и удалении поддержки для старых версий.

что у вас здесь все в порядке. Я использую тот же подход, и он отлично работает для моего приложения. Я выбрал оригинальную идею здесь от Райана Бейтса, где он объясняет очень похожий подход

http://railscasts.com/episodes/350-rest-api-versioning

Это то, что я использую, чтобы указать разные сериализаторы для каждого ресурса:

module API
  module V3
    class AssetController < API::V3::ApiController
      def index
        render json: assets, status: :ok, each_serializer: API::V3::Serializers::AssetSerializer
      end
  end
end

В моей реализации я использую сериализаторы внутри api / controllers / api / v3 / serializers. Итак, вы создаете версии классов сериализаторов и классов контроллеров

Не уверен, что вам действительно нужен get_serializer, так как это более явно, но не имеет большого значения

Если у вас много конечных точек API, попробуйте организовать их по ресурсам. В моем config / rout.rb у меня есть около 700 ресурсов, поэтому я разделил их на отдельные файлы config / api / v1 / rout.rb ...

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

Также это удобно делать внутри инициализатора inflections.rb

ActiveSupport::Inflector.inflections(:en) do |inflect|
  inflect.acronym 'API'
end

Для меня я бы сказал, что самая важная проблема - хорошее тестирование. Я предпочитаю спецификацию и проверяю правильные коды состояния 200, 201, ... и т. Д., А также правильный вывод сына с помощью json_schema

Если вам нужно выполнить аутентификацию, я бы предложил использовать аутентификацию на основе токенов и JWT - JSON Web Token. В своей реализации я использую два токена. Один токен для чтения и другой токен при выполнении POST и PATCH (не уверен, что это необходимо). так внутри контроллера API что-то вроде этого

class ApiController < ActionController::Base
  skip_before_action :verify_authenticity_token, if: :json_request?
  before_action :authenticate

  protected
  def json_request?
    request.format.json?
  end
  if request.headers['X-Authorization']
    token = request.headers['X-Authorization']
    payload = JWT.decode(token, 'my_custom_key_to_check_if_key_has_been_tempered d_on_client_side')[0]
  end
end
 chrisandrew.cl24 июн. 2016 г., 00:28
Спасибо за ваш вклад! Я сделал это, чтобы немного высушить вещи.get_serializer всегда вызывается AMS, и мне нужно только использоватьrender json: @object, serializer: Namespaced::Unconventional::ObjectSerializer если он не следует определенному соглашению.

Ваш ответ на вопрос