diff options
| author | Carlos Antonio da Silva <carlosantoniodasilva@gmail.com> | 2012-03-06 08:26:09 -0300 |
|---|---|---|
| committer | Carlos Antonio da Silva <carlosantoniodasilva@gmail.com> | 2012-03-10 10:15:35 -0300 |
| commit | 6b28c94e20800e6be10b4f7dadff55c3c55f44ce (patch) | |
| tree | 5adbb92c98081a4fd30c5cf41595d216f59471b4 /railties/guides/source | |
| parent | 3e776496d0a85942b65935e69ba63f1d1b5f18fc (diff) | |
| download | rails-6b28c94e20800e6be10b4f7dadff55c3c55f44ce.tar.gz rails-6b28c94e20800e6be10b4f7dadff55c3c55f44ce.tar.bz2 rails-6b28c94e20800e6be10b4f7dadff55c3c55f44ce.zip | |
Add some docs for MiddlewareStackProxy methods and api_only!
[Carlos Antonio da Silva & Santiago Pastorino]
Diffstat (limited to 'railties/guides/source')
| -rw-r--r-- | railties/guides/source/api_app.textile | 5 | ||||
| -rw-r--r-- | railties/guides/source/configuring.textile | 8 |
2 files changed, 10 insertions, 3 deletions
diff --git a/railties/guides/source/api_app.textile b/railties/guides/source/api_app.textile index f2d00c5768..258696385f 100644 --- a/railties/guides/source/api_app.textile +++ b/railties/guides/source/api_app.textile @@ -13,15 +13,14 @@ endprologue. h3. What is an API app? -Traditionally, when people said that they used Rails as an "API", they meant -providing a programmatically accessible API alongside their web application. +Traditionally, when people said that they used Rails as an "API", they meant providing a programmatically accessible API alongside their web application. For example, GitHub provides "an API":http://developer.github.com that you can use from your own custom clients. With the advent of client-side frameworks, more developers are using Rails to build a backend that is shared between their web application and other native applications. For example, Twitter uses its "public API":https://dev.twitter.com in its web application, which is built as a static site that consumes JSON resources. -Instead of using Rails to generate dynamic HTML that will communicate with the server through forms and links, many developers are treating their web application as just another client, delivered as static HTML, CSS and JavaScript, and consuming a simple JSON API +Instead of using Rails to generate dynamic HTML that will communicate with the server through forms and links, many developers are treating their web application as just another client, delivered as static HTML, CSS and JavaScript, and consuming a simple JSON API This guide covers building a Rails application that serves JSON resources to an API client *or* client-side framework. diff --git a/railties/guides/source/configuring.textile b/railties/guides/source/configuring.textile index 0ab1076fff..d72ff57dc5 100644 --- a/railties/guides/source/configuring.textile +++ b/railties/guides/source/configuring.textile @@ -248,6 +248,14 @@ They can also be removed from the stack completely: config.middleware.delete ActionDispatch::BestStandardsSupport </ruby> +In addition to these methods to handle the stack, if your application is going to be used as an API endpoint only, the middleware stack can be configured like this: + +<ruby> +config.middleware.api_only! +</ruby> + +By doing this, Rails will create a smaller middleware stack, by not adding some middlewares that are usually useful for browser access only, such as Cookies, Session and Flash, BestStandardsSupport, and MethodOverride. You can always add any of them later manually if you want. Refer to the "API App docs":api_app.html for more info on how to setup your application for API only apps. + h4. Configuring i18n * +config.i18n.default_locale+ sets the default locale of an application used for i18n. Defaults to +:en+. |