草庐IT

xml - 我应该如何使用 Rails 3.0 创建 REST API?

coder 2024-06-23 原文

我似乎无法在网上找到很多关于在 Rails 中构建 REST API 的不同方法的信息;所以我有两个问题:

  1. 谁能给我指点一些显示不同方法优缺点的文章 方法?
  2. 您能否就以下方法的优缺点分享您的想法?

建议的方法

  1. 当用户在末尾添加 .xml 时,使用标准 Controller 返回 XML 网址的

    优点:

    • 这是 Rails 内置的,非常易于使用
    • 遵循与 Rails 相同的基于资源的方法,因此很容易 现有用户了解/记住

    缺点:

    • API 没有与主站点完全分离,更难维护
    • 人们可能会认为添加 .xml 会在它不起作用的地方起作用

  2. 使用命名空间路由创建仅处理 API 的单独 API Controller 功能,但仍然可以访问网站使用的相同模型

    优点:

    • API 大部分是分离的
    • 仍然使用资源充足的 Controller

    缺点:

    • URL 的形式为 site.com/api/resource.xml 这可能会让人们假设所有 资源可用
    • API 仍然是网站代码/项目的一部分;因此,更难维护

  3. 使用路由转发和约束将所有 API 调用转发到一个 Rack 应用

    优点:

    • API 完全分离
    • 如果我们不想,则不需要使用 Resource-full 样式
    • URL 清楚地表明它是一个 API,您应该查看文档以了解可用的内容 (至少,我的思维方式是这样的;我假设其他开发人员的思维方式也是如此)

    缺点:

    • 更难使用来自网站代码的模型
    • 作为一个单独的项目更容易维护,但这意味着更难与 现有网站
    • 必须保持代码库同步,因为模型可能会因站点功能/错误修复而改变

最佳答案

我建议 API 与您的网站在同一个项目中并不是一件坏事,只要代码是 DRY*。正如您所指出的,拥有单独的代码库是一个挑战,因为您必须使它们与您所做的每个功能/错误修复保持同步。如果它们在同一个地方,维护起来会更容易。只要您保持代码 DRY,此方法无疑是赢家。

我会提供来自 Controller 的 XML 和 JSON,以及一个由 Rails 的路由引擎处理的子域。当有人了解 api.site.com/resource.xml 的模式并尝试访问不存在的资源时,这真的没什么大不了的。只要你的 API 被清楚地记录下来,并且当他们试图访问不在你的 API 中的资源时你优雅地失败/错误,它应该没问题。我会尝试返回一条消息,说明资源不可用,并返回一个指向您的 api 文档的 url。这不应该是任何 API 使用者的运行时问题,因为这应该是发现您的 API 的一部分。

只要我的 0.02 美元。



*DRY = 不要重复自己。 DRY 代码意味着您不会为您的站点和 API 复制粘贴或重写相同的东西;你从多个地方提取和调用。

关于xml - 我应该如何使用 Rails 3.0 创建 REST API?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/3570573/

有关xml - 我应该如何使用 Rails 3.0 创建 REST API?的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  4. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  5. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  6. ruby-on-rails - rails : keeping DRY with ActiveRecord models that share similar complex attributes - 2

    这似乎应该有一个直截了当的答案,但在Google上花了很多时间,所以我找不到它。这可能是缺少正确关键字的情况。在我的RoR应用程序中,我有几个模型共享一种特定类型的字符串属性,该属性具有特殊验证和其他功能。我能想到的最接近的类似示例是表示URL的字符串。这会导致模型中出现大量重复(甚至单元测试中会出现更多重复),但我不确定如何让它更DRY。我能想到几个可能的方向...按照“validates_url_format_of”插件,但这只会让验证干给这个特殊的字符串它自己的模型,但这看起来很像重溶液为这个特殊的字符串创建一个ruby​​类,但是我如何得到ActiveRecord关联这个类模型

  7. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  8. ruby - 如何在 Ruby 中顺序创建 PI - 2

    出于纯粹的兴趣,我很好奇如何按顺序创建PI,而不是在过程结果之后生成数字,而是让数字在过程本身生成时显示。如果是这种情况,那么数字可以自行产生,我可以对以前看到的数字实现垃圾收集,从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法,类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

  9. ruby-on-rails - 在 Rails 中将文件大小字符串转换为等效千字节 - 2

    我的目标是转换表单输入,例如“100兆字节”或“1GB”,并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前,我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效,但前提是输入是倍数(“gigabytes”,而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以,功能正常,

  10. ruby-on-rails - Ruby net/ldap 模块中的内存泄漏 - 2

    作为我的Rails应用程序的一部分,我编写了一个小导入程序,它从我们的LDAP系统中吸取数据并将其塞入一个用户表中。不幸的是,与LDAP相关的代码在遍历我们的32K用户时泄漏了大量内存,我一直无法弄清楚如何解决这个问题。这个问题似乎在某种程度上与LDAP库有关,因为当我删除对LDAP内容的调用时,内存使用情况会很好地稳定下来。此外,不断增加的对象是Net::BER::BerIdentifiedString和Net::BER::BerIdentifiedArray,它们都是LDAP库的一部分。当我运行导入时,内存使用量最终达到超过1GB的峰值。如果问题存在,我需要找到一些方法来更正我的代

随机推荐