1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-25 00:12:59 +01:00
actix-extras/guide/src/qs_2.md

99 lines
2.6 KiB
Markdown
Raw Normal View History

2017-11-28 01:41:37 +01:00
# Getting Started
Lets create and run our first actix web application. Well create a new Cargo project
that depends on actix web and then run the application.
In previous section we already installed required rust version. Now let's create new cargo projects.
## Hello, world!
Lets write our first actix web application! Start by creating a new binary-based
Cargo project and changing into the new directory:
```bash
cargo new hello-world --bin
cd hello-world
```
Now, add actix and actix web as dependencies of your project by ensuring your Cargo.toml
contains the following:
```toml
[dependencies]
actix = "0.3"
actix-web = { git = "https://github.com/actix/actix-web" }
```
In order to implement a web server, first we need to create a request handler.
A request handler is a function that accepts a `HttpRequest` instance as its only parameter
2017-11-29 03:00:10 +01:00
and returns a type that can be converted into `HttpResponse`:
2017-11-28 01:41:37 +01:00
2017-12-04 22:32:05 +01:00
```rust
# extern crate actix_web;
# use actix_web::*;
fn index(req: HttpRequest) -> &'static str {
"Hello world!"
}
# fn main() {}
2017-11-28 01:41:37 +01:00
```
Next, create an `Application` instance and register the
request handler with the application's `resource` on a particular *HTTP method* and *path*::
2017-12-04 22:32:05 +01:00
```rust
# extern crate actix_web;
# use actix_web::*;
# fn index(req: HttpRequest) -> &'static str {
# "Hello world!"
# }
# fn main() {
let app = Application::new()
2017-12-14 07:36:28 +01:00
.resource("/", |r| r.f(index))
2017-12-04 22:32:05 +01:00
.finish();
# }
2017-11-28 01:41:37 +01:00
```
After that, application instance can be used with `HttpServer` to listen for incoming
connections. Server accepts function that should return `HttpHandler` instance:
2017-11-28 01:41:37 +01:00
```rust,ignore
2017-12-20 03:44:17 +01:00
HttpServer::new(|| app)
.bind("127.0.0.1:8088")?
.start();
2017-11-28 01:41:37 +01:00
```
That's it. Now, compile and run the program with cargo run.
Head over to ``http://localhost:8088/`` to see the results.
Here is full source of main.rs file:
```rust
extern crate actix;
extern crate actix_web;
2017-11-29 04:49:17 +01:00
use actix_web::*;
2017-11-28 01:41:37 +01:00
2017-11-28 22:52:53 +01:00
fn index(req: HttpRequest) -> &'static str {
"Hello world!"
2017-11-28 01:41:37 +01:00
}
fn main() {
let sys = actix::System::new("example");
HttpServer::new(
|| Application::new()
.resource("/", |r| r.f(index)))
2017-12-17 21:35:04 +01:00
.bind("127.0.0.1:8088").unwrap()
.start();
2017-11-28 01:41:37 +01:00
println!("Started http server: 127.0.0.1:8088");
2017-12-09 00:25:37 +01:00
# actix::Arbiter::system().send(actix::msgs::SystemExit(0));
2017-11-28 01:41:37 +01:00
let _ = sys.run();
}
```
2017-11-28 04:56:14 +01:00
Note on `actix` crate. Actix web framework is built on top of actix actor library.
`actix::System` initializes actor system, `HttpServer` is an actor and must run within
2017-12-20 03:44:17 +01:00
properly configured actix system. For more information please check
2017-11-28 04:56:14 +01:00
[actix documentation](https://actix.github.io/actix/actix/)