Update README and docs.
This makes src/lib.rs the primary source for crate-level documentation. I've generated README.md with `cargo readme > README.md`. Since links to specific documentation items should be relative when possible, but must be absolute in README.md, I've used the new syntax for intra-rustdoc links (https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md), along with a README.tpl that sets up those links to point at the absolute versions. `cargo readme` uses the README.tpl by default. I've also rewritten the crate level docs, removing some TODO information at the bottom, and moving the license information to CONTRIBUTING.md.
This commit is contained in:
Jacob Hoffman-Andrews
230
README.md
230
README.md
@@ -1,115 +1,167 @@
|
||||
[comment]: # (README.md is autogenerated from src/lib.rs by `cargo readme > README.md`)
|
||||
|
||||
# ureq
|
||||
|
||||
|
||||
[](https://crates.io/crates/ureq)
|
||||
[](https://docs.rs/ureq)
|
||||
A simple, safe HTTP client.
|
||||
|
||||
> Minimal request library in rust.
|
||||
Ureq's first priority is being easy for you to use. It's great for
|
||||
anyone who wants a low-overhead HTTP client that just gets the job done. Works
|
||||
very well with HTTP APIs. Its features include cookies, JSON, HTTP proxies,
|
||||
HTTPS, and charset decoding.
|
||||
|
||||
## Usage
|
||||
Ureq is in pure Rust for safety and ease of understanding. It avoids using
|
||||
`unsafe` directly. It uses blocking I/O instead of async I/O, because that keeps
|
||||
the API simple and and keeps dependencies to a minimum. For TLS, ureq uses
|
||||
[rustls].
|
||||
|
||||
### Usage
|
||||
|
||||
In its simplest form, ureq looks like this:
|
||||
|
||||
```rust
|
||||
// sync post request of some json.
|
||||
// requires feature:
|
||||
// `ureq = { version = "*", features = ["json"] }`
|
||||
let resp = ureq::post("https://myapi.example.com/ingest")
|
||||
.set("X-My-Header", "Secret")
|
||||
.send_json(serde_json::json!({
|
||||
"name": "martin",
|
||||
"rust": true
|
||||
}))?;
|
||||
|
||||
// .ok() tells if response is 200-299.
|
||||
if resp.ok() {
|
||||
println!("success: {}", resp.into_string()?);
|
||||
} else {
|
||||
println!("error {}: {}", resp.status(), resp.into_string()?);
|
||||
}
|
||||
let body: String = ureq::get("http://example.com")
|
||||
.set("Accept", "text/html")
|
||||
.call()?
|
||||
.into_string()?;
|
||||
```
|
||||
|
||||
## About 1.0.0
|
||||
For more involved tasks, you'll want to create an [Agent]. An Agent
|
||||
holds a connection pool for reuse, and a cookie store if you use the
|
||||
"cookies" feature. An Agent can be cheaply cloned due to an internal
|
||||
[Arc](std::sync::Arc) and all clones of an Agent share state among each other. Creating
|
||||
an Agent also allows setting options like the TLS configuration.
|
||||
|
||||
This crate is now 1.x.x. It signifies there will be no more breaking
|
||||
API changes (for better or worse). I personally use this code in
|
||||
production system reading data from AWS. Whether the quality is good
|
||||
enough for other use cases is a "YMMV".
|
||||
```rust
|
||||
use ureq::{Agent, AgentBuilder};
|
||||
use std::time::Duration;
|
||||
|
||||
## ureq's future
|
||||
let agent: Agent = ureq::AgentBuilder::new()
|
||||
.timeout_read(Duration::from_secs(5))
|
||||
.timeout_write(Duration::from_secs(5))
|
||||
.build();
|
||||
let body: String = agent.get("http://example.com/page")
|
||||
.call()?
|
||||
.into_string()?;
|
||||
|
||||
I asked for feedback on [ureq's future
|
||||
direction](https://www.reddit.com/r/rust/comments/eu6qg8/future_of_ureq_http_client_library/)
|
||||
and came to the conclusion that there's enough interest in a simple
|
||||
blocking http client to keep it going. Another motivation is that I
|
||||
use it extensively for my own work, to talk to S3.
|
||||
// Reuses the connection from previous request.
|
||||
let response: String = agent.put("http://example.com/upload")
|
||||
.set("Authorization", "example-token")
|
||||
.call()?
|
||||
.into_string()?;
|
||||
```
|
||||
|
||||
I'll keep maintaining ureq. I will try to keep dependencies somewhat
|
||||
fresh and try to address bad bugs. I will however not personally
|
||||
implement new features in ureq, but I do welcome PR with open arms.
|
||||
Ureq supports sending and receiving json, if you enable the "json" feature:
|
||||
|
||||
The code base is extremely simple, one might even call naive. It's a
|
||||
good project to hack on as first learning experience in Rust. I will
|
||||
uphold some base line of code hygiene, but won't block a PR due to
|
||||
something being a bit inelegant.
|
||||
```rust
|
||||
// Requires the `json` feature enabled.
|
||||
let resp: String = ureq::post("http://myapi.example.com/ingest")
|
||||
.set("X-My-Header", "Secret")
|
||||
.send_json(ureq::json!({
|
||||
"name": "martin",
|
||||
"rust": true
|
||||
}))?
|
||||
.into_string()?;
|
||||
```
|
||||
|
||||
## Features
|
||||
### Features
|
||||
|
||||
To enable a minimal dependency tree, some features are off by default.
|
||||
You can control them when including `ureq` as a dependency.
|
||||
You can control them when including ureq as a dependency.
|
||||
|
||||
```
|
||||
ureq = { version = "*", features = ["json", "charset"] }
|
||||
```
|
||||
`ureq = { version = "*", features = ["json", "charset"] }`
|
||||
|
||||
* `tls` enables https. This is enabled by default.
|
||||
* `cookies` enables handling cookies between requests in an agent.
|
||||
* `json` enables `response.into_json()` and `request.send_json()` via serde_json.
|
||||
* `charset` enables interpreting the charset part of
|
||||
`Content-Type: text/plain; charset=iso-8859-1`. Without this, the library
|
||||
defaults to rust's built in `utf-8`.
|
||||
* `cookies` enables cookies.
|
||||
* `json` enables [Response::into_json()] and [Request::send_json()] via serde_json.
|
||||
* `charset` enables interpreting the charset part of the Content-Type header
|
||||
(e.g. `Content-Type: text/plain; charset=iso-8859-1`). Without this, the
|
||||
library defaults to Rust's built in `utf-8`.
|
||||
|
||||
## Motivation
|
||||
## Plain requests
|
||||
|
||||
* Minimal dependency tree
|
||||
* Obvious API
|
||||
* Blocking API
|
||||
* Convenience over correctness
|
||||
* No use of unsafe
|
||||
Most standard methods (GET, POST, PUT etc), are supported as functions from the
|
||||
top of the library ([get()], [post()], [put()], etc).
|
||||
|
||||
This library tries to provide a convenient request library with a minimal dependency
|
||||
tree and an obvious API. It is inspired by libraries like
|
||||
These top level http method functions create a [Request] instance
|
||||
which follows a build pattern. The builders are finished using:
|
||||
|
||||
* [`.call()`][Request::call()] without a request body.
|
||||
* [`.send()`][Request::send()] with a request body as [Read][std::io::Read] (chunked encoding support for non-known sized readers).
|
||||
* [`.send_string()`][Request::send_string()] body as string.
|
||||
* [`.send_bytes()`][Request::send_bytes()] body as bytes.
|
||||
* [`.send_form()`][Request::send_form()] key-value pairs as application/x-www-form-urlencoded.
|
||||
|
||||
## JSON
|
||||
|
||||
By enabling the `ureq = { version = "*", features = ["json"] }` feature,
|
||||
the library supports serde json.
|
||||
|
||||
* [`request.send_json()`][Request::send_json()] send body as serde json.
|
||||
* [`response.into_json()`][Response::into_json()] transform response to json.
|
||||
|
||||
## Content-Length and Transfer-Encoding
|
||||
|
||||
The library will send a Content-Length header on requests with bodies of
|
||||
known size, in other words, those sent with
|
||||
[`.send_string()`][Request::send_string()],
|
||||
[`.send_bytes()`][Request::send_bytes()],
|
||||
[`.send_form()`][Request::send_form()], or
|
||||
[`.send_json()`][Request::send_json()]. If you send a
|
||||
request body with [`.send()`][Request::send()],
|
||||
which takes a [Read][std::io::Read] of unknown size, ureq will send Transfer-Encoding:
|
||||
chunked, and encode the body accordingly. Bodyless requests
|
||||
(GETs and HEADs) are sent with [`.call()`][Request::call()]
|
||||
and ureq adds neither a Content-Length nor a Transfer-Encoding header.
|
||||
|
||||
If you set your own Content-Length or Transfer-Encoding header before
|
||||
sending the body, ureq will respect that header by not overriding it,
|
||||
and by encoding the body or not, as indicated by the headers you set.
|
||||
|
||||
```rust
|
||||
let resp = ureq::post("http://my-server.com/ingest")
|
||||
.set("Transfer-Encoding", "chunked")
|
||||
.send_string("Hello world");
|
||||
```
|
||||
|
||||
## Character encoding
|
||||
|
||||
By enabling the `ureq = { version = "*", features = ["charset"] }` feature,
|
||||
the library supports sending/receiving other character sets than `utf-8`.
|
||||
|
||||
For [`response.into_string()`][Response::into_string()] we read the
|
||||
header `Content-Type: text/plain; charset=iso-8859-1` and if it contains a charset
|
||||
specification, we try to decode the body using that encoding. In the absence of, or failing
|
||||
to interpret the charset, we fall back on `utf-8`.
|
||||
|
||||
Similarly when using [`request.send_string()`][Request::send_string()],
|
||||
we first check if the user has set a `; charset=<whatwg charset>` and attempt
|
||||
to encode the request body using that.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
Ureq is inspired by other great HTTP clients like
|
||||
[superagent](http://visionmedia.github.io/superagent/) and
|
||||
[fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
|
||||
[the fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
|
||||
|
||||
### Sync forever
|
||||
If ureq is not what you're looking for, check out these other Rust HTTP clients:
|
||||
[surf](https://crates.io/crates/surf), [reqwest](https://crates.io/crates/reqwest),
|
||||
[isahc](https://crates.io/crates/isahc), [attohttpc](https://crates.io/crates/attohttpc),
|
||||
[actix-web](https://crates.io/crates/actix-web), and [hyper](https://crates.io/crates/hyper).
|
||||
|
||||
This library uses blocking socket reads and writes. When it was
|
||||
created, there wasn't any async/await support in rust, and for my own
|
||||
purposes, blocking IO was fine. At this point, one good reason to keep
|
||||
this library going is that it is blocking (the other is that it does not
|
||||
use unsafe).
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] Forms with application/x-www-form-urlencoded
|
||||
- [ ] multipart/form-data
|
||||
- [ ] Expect 100-continue
|
||||
- [x] Use `rustls` when [ring with versioned asm symbols](https://github.com/briansmith/ring/pull/619) is released. (PR is not resolved, but most implementations have settled on 0.13)
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2019 Martin Algesten
|
||||
|
||||
Licensed under either of
|
||||
|
||||
* Apache License, Version 2.0
|
||||
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
||||
* MIT license
|
||||
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
||||
|
||||
at your option.
|
||||
|
||||
## Contribution
|
||||
|
||||
Unless you explicitly state otherwise, any contribution intentionally submitted
|
||||
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
|
||||
dual licensed as above, without any additional terms or conditions.
|
||||
[rustls]: https://docs.rs/rustls/
|
||||
[std::sync::Arc]: https://doc.rust-lang.org/stable/alloc/sync/struct.Arc.html
|
||||
[std::io::Read]: https://doc.rust-lang.org/stable/std/io/trait.Read.html
|
||||
[Agent]: https://docs.rs/ureq/latest/ureq/struct.Agent.html
|
||||
[get()]: https://docs.rs/ureq/latest/ureq/fn.get.html
|
||||
[post()]: https://docs.rs/ureq/latest/ureq/fn.post.html
|
||||
[put()]: https://docs.rs/ureq/latest/ureq/fn.put.html
|
||||
[Request]: https://docs.rs/ureq/latest/ureq/struct.Request.html
|
||||
[Request::call()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.call
|
||||
[Request::send()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send
|
||||
[Request::send_bytes()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send_bytes
|
||||
[Request::send_string()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send_string
|
||||
[Request::send_json()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send_json
|
||||
[Request::send_form()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send_form
|
||||
[Response::into_json()]: https://docs.rs/ureq/latest/ureq/struct.Response.html#method.into_json
|
||||
[Response::into_string()]: https://docs.rs/ureq/latest/ureq/struct.Response.html#method.into_string
|
||||
|
||||
Reference in New Issue
Block a user