草庐IT

c# - ASP.NET MVC 应用程序的版本控制 REST API

coder 2024-05-30 原文

我正在考虑在 ASP.NET MVC 3 中开发一个应用程序，并希望同时提供一个公共(public) API。

环顾四周，似乎有两种方法可以解决这个问题。创建一个 API 区域并拥有返回 json/xml 的 Controller 。或者使用操作过滤器和一组前端 Controller ，并根据请求 header 让它们返回 json/xml/html。

我想稍后做，但我想知道如果你走这条路，你怎么能对你的 api 进行版本控制？

如果您采用第一种方式，您可以轻松地创建一个 v1/v2 Controller ，但如果采用第二种方式，您如何对其进行版本控制？

最佳答案

版本控制从一开始就是一个相当复杂的问题。以下是我之前看过的方法:

  1. 网址。在这种情况下 https://api.example.com/v1/projects假定为与 http://api.example.com/v2/projects 不同的资源，尽管事实并非如此。 Basecamp似乎是这样做的。按照这种方法，假设您将始终必须支持旧 API。
  2. 标题。 URL 保持不变，但是，客户端传递一个额外的 HTTP header ，例如 X-MYAPI-VERSION，每个请求都有一个标识要使用的 API 版本的值。 Google Documents List API做这个。这种方法的一个潜在问题是 HTTP header 可能会被客户端和服务器之间的中介剥离。
  3. 参数。要避免选项 2 的问题，您可以传递 API 版本以用作参数(例如 https://api.example.com/projects?v=3 )。
  4. 媒体类型。此处您的 URL 保持不变，但是，用户需要使用接受和内容类型 header 指定资源的表示形式。例如，可以使用“application/vnd.mycompany.resource[-version][+format]”来呈现“项目”，为 v1 json 或“application/vnd.mycompany.project-v1+xml”用于 v1 xml。当您需要项目的新版本时，mime 类型可能如下所示“application/vnd.mycompany.project-v2+xml”。 Github似乎支持这一点。
  5. 有效载荷的一部分。在这种情况下，请求的有效负载包含要使用的版本号。例如，当传递 XML 时，您可以查看 namespace 以确定正在使用的 API 版本。对于 JSON，您可以使用“$version”或“_version”属性来指定版本。
  6. 客户端 key 。注册应用程序时，它会指定要使用的 API 版本。当您验证客户端时，您确保您模拟它想要使用的版本。
  7. 没有明确的版本控制 始终可以选择不对您的 API 进行版本控制，并尝试透明地处理更改，方法是将所有字段设为可选，并在缺少时适本地处理它们。无论如何，您很可能会这样做，以使您的 API 的 future 版本与您今天开发的版本兼容。

许多人推荐选项 4，尽管它并不总是实用。这些选项中的大多数都需要额外的工作才能使用 ASP.NET MVC。

关于c# - ASP.NET MVC 应用程序的版本控制 REST API，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/9197931/

c#RESTstrongnoreferrersectionasp.net-mvc-3api

有关c# - ASP.NET MVC 应用程序的版本控制 REST API的更多相关文章

  1. ruby - 在 Ruby 程序执行时阻止 Windows 7 PC 进入休眠状态 - 2

    我需要在客户计算机上运行Ruby应用程序。通常需要几天才能完成(复制大备份文件)。问题是如果启用sleep，它会中断应用程序。否则，计算机将持续运行数周，直到我下次访问为止。有什么方法可以防止执行期间休眠并让Windows在执行后休眠吗？欢迎任何疯狂的想法;-) 最佳答案 Here建议使用SetThreadExecutionStateWinAPI函数，使应用程序能够通知系统它正在使用中，从而防止系统在应用程序运行时进入休眠状态或关闭显示。像这样的东西:require'Win32API'ES_AWAYMODE_REQUIRED=0x0

  2. ruby - 将差异补丁应用于字符串/文件 - 2

    对于具有离线功能的智能手机应用程序，我正在为Xml文件创建单向文本同步。我希望我的服务器将增量/差异(例如GNU差异补丁)发送到目标设备。这是计划:Time=0Server:hasversion_1ofXmlfile(~800kiB)Client:hasversion_1ofXmlfile(~800kiB)Time=1Server:hasversion_1andversion_2ofXmlfile(each~800kiB)computesdeltaoftheseversions(=patch)(~10kiB)sendspatchtoClient(~10kiBtransferred)Cl

  3. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时，rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  4. ruby - 在 Ruby 中编写命令行实用程序 - 2

    我想用ruby​​编写一个小的命令行实用程序并将其作为gem分发。我知道安装后，Guard、Sass和Thor等某些gem可以从命令行自行运行。为了让gem像二进制文件一样可用，我需要在我的gemspec中指定什么。 最佳答案 Gem::Specification.newdo|s|...s.executable='name_of_executable'...endhttp://docs.rubygems.org/read/chapter/20 关于ruby-在Ruby中编写命令行实用程序

  5. ruby-on-rails - Rails 应用程序之间的通信 - 2

    我构建了两个需要相互通信和发送文件的Rails应用程序。例如，一个Rails应用程序会发送请求以查看其他应用程序数据库中的表。然后另一个应用程序将呈现该表的json并将其发回。我还希望一个应用程序将存储在其公共(public)目录中的文本文件发送到另一个应用程序的公共(public)目录。我从来没有做过这样的事情，所以我什至不知道从哪里开始。任何帮助，将不胜感激。谢谢! 最佳答案 无论Rails是什么，几乎所有Web应用程序都有您的要求，大多数现代Web应用程序都需要相互通信。但是有一个小小的理解需要你坚持下去，网站不应直接访问彼此

  6. ruby - 无法运行 Rails 2.x 应用程序 - 2

    我尝试运行2.x应用程序。我使用rvm并为此应用程序设置其他版本的ruby​​:$rvmuseree-1.8.7-head我尝试运行服务器，然后出现很多错误:$script/serverNOTE:Gem.source_indexisdeprecated,useSpecification.Itwillberemovedonorafter2011-11-01.Gem.source_indexcalledfrom/Users/serg/rails_projects_terminal/work_proj/spohelp/config/../vendor/rails/railties/lib/r

  7. ruby-on-rails - Rails 应用程序中的 Rails : How are you using application_controller. rb 是新手吗？ - 2

    刚入门rails，开始慢慢理解。有人可以解释或给我一些关于在application_controller中编码的好处或时间和原因的想法吗？有哪些用例。您如何为Rails应用程序使用应用程序Controller？我不想在那里放太多代码，因为据我了解，每个请求都会调用此Controller。这是真的？ 最佳答案 ApplicationController实际上是您应用程序中的每个其他Controller都将从中继承的类(尽管这不是强制性的)。我同意不要用太多代码弄乱它并保持干净整洁的态度，尽管在某些情况下ApplicationContr

  8. Ruby Readline 在向上箭头上使控制台崩溃 - 2

    当我在Rails控制台中按向上或向左箭头时，出现此错误:irb(main):001:0>/Users/me/.rvm/gems/ruby-2.0.0-p247/gems/rb-readline-0.4.2/lib/rbreadline.rb:4269:in`blockin_rl_dispatch_subseq':invalidbytesequenceinUTF-8(ArgumentError)我使用rvm来管理我的ruby​​安装。我正在使用=>ruby-2.0.0-p247[x86_64]我使用bundle来管理我的gem，并且我有rb-readline(0.4.2)(人们推荐的最少

  9. ruby-on-rails - 项目升级后 Pow 不会更改 ruby​​ 版本 - 2

    我在我的Rails项目中使用Pow和powifygem。现在我尝试升级我的ruby​​版本(从1.9.3到2.0.0，我使用RVM)当我切换ruby​​版本、安装所有gem依赖项时，我通过运行railss并访问localhost:3000确保该应用程序正常运行以前，我通过使用pow访问http://my_app.dev来浏览我的应用程序。升级后，由于错误Bundler::RubyVersionMismatch:YourRubyversionis1.9.3,butyourGemfilespecified2.0.0，此url不起作用我尝试过的:重新创建pow应用程序重启pow服务器更新战俘

  10. ruby-on-rails - 带 Spring 锁的 Rails 4 控制台 - 2

    我正在使用Ruby2.1.1和Rails4.1.0.rc1。当执行railsc时，它被锁定了。使用Ctrl-C停止，我得到以下错误日志:~/.rvm/gems/ruby-2.1.1/gems/spring-1.1.2/lib/spring/client/run.rb:47:in`gets':Interruptfrom~/.rvm/gems/ruby-2.1.1/gems/spring-1.1.2/lib/spring/client/run.rb:47:in`verify_server_version'from~/.rvm/gems/ruby-2.1.1/gems/spring-1.1.

随机推荐