如何在现有Rails应用中接入独立LDAP授权API路由？

嘿，这个需求太贴合实际场景了——既要保持独立应用的开发测试节奏，又要贴合Rails生态的一致性，Rails引擎绝对是最优解，完美踩中你所有的需求点！

为什么选Rails引擎？ #

• 天生为"可复用、独立的Rails组件"设计：拥有完整的Rails目录结构（控制器、路由、测试、Gemfile），可以独立开发、调试、发布，完全不依赖主应用
• 完美支持路由挂载：能轻松把引擎的所有API路由映射到主应用的/ldap-auth路径下，无需复杂配置
• 100%贴合Rails代码风格：和主应用共享Rails的开发规范、工具链，团队维护成本极低，不会出现技术栈割裂的问题

具体实现步骤 #

1. 创建API优先的挂载式引擎

用Rails自带的插件生成命令，直接创建一个API模式的挂载式引擎：

rails plugin new ldap_auth --mountable --api

• --mountable：生成完全隔离的引擎，有独立的命名空间（比如LdapAuth::），避免和主应用的代码冲突
• --api：生成API模式的引擎，自动移除视图、assets等不必要的组件，更适合纯API应用

2. 实现LDAP授权的API逻辑

在引擎的目录里，像开发普通Rails API一样写代码：

• 在app/controllers/ldap_auth下创建控制器，比如AuthController，集成LDAP客户端（推荐用net-ldap gem，或者devise_ldap_authenticatable如果需要和Devise结合）
• 在config/routes.rb里定义API路由，比如：

# ldap_auth/config/routes.rb
namespace :api, defaults: { format: :json } do
  post '/login', to: 'auth#login'
  get '/verify', to: 'auth#verify'
end

3. 在主应用挂载引擎

打开主应用的config/routes.rb，添加挂载配置：

# 主应用config/routes.rb
mount LdapAuth::Engine, at: '/ldap-auth'

这样引擎里的所有路由都会自动带上/ldap-auth前缀，比如刚才定义的/api/login会变成主应用的/ldap-auth/api/login

4. 独立测试与发布

• 测试：引擎自带test/dummy目录，可以在dummy app里模拟主应用环境测试；也可以直接在引擎目录下运行rails test，独立执行测试用例
• 发布：把引擎打包成Gem，推送到私有Gem源或者RubyGems，主应用通过Gemfile引入：

# 主应用Gemfile
gem 'ldap_auth', git: 'https://your-git-repo/ldap_auth.git', tag: 'v1.0.0'

这样引擎的发布周期完全独立，主应用可以按需升级版本，互不干扰

额外优化建议 #

• 配置隔离：在引擎的lib/ldap_auth/engine.rb里添加可配置项，比如LDAP服务器地址、端口，主应用可以在config/initializers/ldap_auth.rb里覆盖配置
• 避免耦合：尽量保持引擎的独立性，不要依赖主应用的模型或业务逻辑，如果需要共享资源，可以通过引擎的initializer暴露接口
• 文档规范：给引擎写好README，说明API接口、配置方式、版本更新日志，方便团队协作

为什么不选其他方案？ #

• Sinatra/Rack app：虽然能挂载到Rails，但代码风格、工具链和Rails差异大，维护成本高，不符合"代码库一致性"的要求
• 直接在主应用加模块：会破坏主应用的代码结构，无法实现独立的测试和发布周期

内容的提问来源于stack exchange，提问作者Jonah