README.md in rails_api_documentation-0.2.2 vs README.md in rails_api_documentation-0.2.3
- old
+ new
@@ -26,10 +26,14 @@
## Usage
To display api documentation on route '/api_doc' you need to:
+0. config/application.rb ->
+```ruby
+ require 'rails_api_doc'
+```
1. config/routes.rb ->
```ruby
mount RailsApiDoc::Engine => '/api_doc'
```
@@ -53,9 +57,10 @@
end
parameter :test, type: String, required: true
end
```
+3. go to localhost:3000/api_doc
## Strong params
You may want to use your defined request api to filter incoming parameters.
Usually we use something like `params.permit(:name, :age)`, but no more!