diff options
Diffstat (limited to 'railties/lib/rails_generator/generators/components/web_service')
| -rw-r--r-- | railties/lib/rails_generator/generators/components/web_service/USAGE | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/railties/lib/rails_generator/generators/components/web_service/USAGE b/railties/lib/rails_generator/generators/components/web_service/USAGE index d3e45b7fef..1b9192f7b1 100644 --- a/railties/lib/rails_generator/generators/components/web_service/USAGE +++ b/railties/lib/rails_generator/generators/components/web_service/USAGE @@ -1,28 +1,24 @@ Description: - The web service generator creates the controller and API definition for - a web service. + Stubs out the controller and API for a new web service using the deprecated + Action Web Service framework. Pass the web service name, either CamelCased + or under_scored, and a list of API methods as arguments. To create a web + service within a module, use a path like 'module_name/web_service_name'. - The generator takes a web service name and a list of API methods as arguments. - The web service name may be given in CamelCase or under_score and should - contain no extra suffixes. To create a web service within a - module, specify the web service name as 'module/webservice'. - - The generator creates a controller class in app/controllers, an API definition - in app/apis, and a functional test suite in test/functional. + This generates a controller in app/controllers, an API definition + in app/apis, and functional tests in test/functional. Example: - ./script/generate web_service User add edit list remove + `./script/generate web_service User add edit list remove` - User web service. + creates the User controller, API, and functional test: Controller: app/controllers/user_controller.rb API: app/apis/user_api.rb Test: test/functional/user_api_test.rb Modules Example: - ./script/generate web_service 'api/registration' register renew + `./script/generate web_service 'api/registration' register renew` - Registration web service. + creates the Registration controller, API, and functional test: Controller: app/controllers/api/registration_controller.rb API: app/apis/api/registration_api.rb Test: test/functional/api/registration_api_test.rb - |