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

Fixes TODOs in introduction.

Browse Source
This commit is contained in:
iMacTia 2019-06-08 17:32:19 +01:00
parent f851834ccd
commit a963c12a82
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/introduction/index.md
View File

@ -48,7 +48,7 @@ resp = Faraday.get(url, {a: 1}, {'Accept' => 'application/json'})
# => GET http://sushi.com/nigiri/sake.json?a=1
```
TODO: Link to query encoding config
[Learn more about parameters encoding][encoding]
### Requests with a body
@ -70,8 +70,6 @@ resp = Faraday.post(url, '{"choice": "sake"}',
"Content-Type" => "application/json")
```
TODO: Link to json middleware?
#### Form upload
Faraday can automatically convert hashes to values for form or multipart request
@ -83,7 +81,7 @@ resp = Faraday.post(url, choice: 'sake')
# => POST 'choice=sake' to http://sushi.com/fave
```
TODO: Link to query encoding config
[Learn more about uploading files][multipart]
### Detailed HTTP Requests
@ -128,4 +126,7 @@ end
A `Faraday::Connection` object can also be used to change the default HTTP
adapter or add custom middleware that runs during Faraday's request/response
cycle. See the [Middleware](../middleware) page for more details.
cycle. See the [Middleware](../middleware) page for more details.
[encoding]: ../middleware/url-encoded
[multipart]: ../middleware/multipart