aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source
diff options
context:
space:
mode:
authorEileen M. Uchitelle <eileencodes@gmail.com>2016-06-29 21:08:27 -0400
committerGitHub <noreply@github.com>2016-06-29 21:08:27 -0400
commitfe054e02b29340c6d9265f9b4ea2ea7d9a872156 (patch)
tree8471f22e8e7d426ee0bbf1aa8de6e533f2d058a4 /guides/source
parented6eb8276ada7a4ab4cdaa37d3d7fa466f1dc43b (diff)
parent5609e0021f8c51b4505bc446f5a8c898ba7d72ae (diff)
downloadrails-fe054e02b29340c6d9265f9b4ea2ea7d9a872156.tar.gz
rails-fe054e02b29340c6d9265f9b4ea2ea7d9a872156.tar.bz2
rails-fe054e02b29340c6d9265f9b4ea2ea7d9a872156.zip
Merge pull request #25583 from vipulnsward/add-api-apps-to-release-notes
Add API Apps to release notes
Diffstat (limited to 'guides/source')
-rw-r--r--guides/source/5_0_release_notes.md31
1 files changed, 28 insertions, 3 deletions
diff --git a/guides/source/5_0_release_notes.md b/guides/source/5_0_release_notes.md
index ed4481f151..f0c7f03bf2 100644
--- a/guides/source/5_0_release_notes.md
+++ b/guides/source/5_0_release_notes.md
@@ -52,10 +52,35 @@ choice.
See the [Action Cable Overview](action_cable_overview.html) guide for more
information.
-### Rails API
-[Pull Request](https://github.com/rails/rails/pull/19832)
+### API Applications
-ToDo...
+Rails can now be used to create slimmed down API only applications.
+This is useful for creating and serving APIs similar to [Twitter](https://dev.twitter.com) or [GitHub](http://developer.github.com) API,
+that can be used to serve public facing, as well as, for custom applications.
+
+You can generate a new api Rails app using:
+
+```bash
+$ rails new my_api --api
+```
+
+This will do three main things:
+
+- Configure your application to start with a more limited set of middleware
+ than normal. Specifically, it will not include any middleware primarily useful
+ for browser applications (like cookies support) by default.
+- Make `ApplicationController` inherit from `ActionController::API` instead of
+ `ActionController::Base`. As with middleware, this will leave out any Action
+ Controller modules that provide functionalities primarily used by browser
+ applications.
+- Configure the generators to skip generating views, helpers and assets when
+ you generate a new resource.
+
+The application provides a base for APIs,
+that can then be [configured to pull in functionality](api_app.html) as suitable for the application's needs.
+
+See the [Using Rails for API-only Applications](api_app.html) guide for more
+information.
### Active Record attributes API