sharpetronics/faraday
1
0
Fork 0
mirror of https://github.com/lostisland/faraday.git synced 2025-12-10 00:04:51 -05:00
Code Issues Projects Releases Wiki Activity

Expand on params_encoder documentation

Browse Source
This commit is contained in:
Mislav Marohnić 2015-10-02 18:19:02 +02:00
parent ad52344e63
commit a921a30f8b
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -68,16 +68,28 @@ response = Faraday.get 'http://sushi.com/nigiri/sake.json'
Sometimes you need to send the same URL parameter multiple times with different Sometimes you need to send the same URL parameter multiple times with different
values. This requires manually setting the parameter encoder and can be done on values. This requires manually setting the parameter encoder and can be done on
a per-connection basis. either per-connection or per-request basis.
```ruby ```ruby
conn.options.params_encoder = Faraday::FlatParamsEncoder # per-connection setting
conn = Faraday.new :params_encoder => Faraday::FlatParamsEncoder
conn.get do |req| conn.get do |req|
# per-request setting:
# req.options.params_encoder = my_encoder
req.params['roll'] = ['california', 'philadelphia'] req.params['roll'] = ['california', 'philadelphia']
end end
# GET 'http://sushi.com?roll=california&roll=philadelphia' # GET 'http://sushi.com?roll=california&roll=philadelphia'
``` ```
The value of Faraday `params_encoder` can be any object that responds to:
* `encode(hash) #=> String`
* `decode(string) #=> Hash`
The encoder will affect both how query strings are processed and how POST bodies
get serialized. The default encoder is Faraday::NestedParamsEncoder.
## Advanced middleware usage ## Advanced middleware usage
The order in which middleware is stacked is important. Like with Rack, the The order in which middleware is stacked is important. Like with Rack, the