mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-25 00:12:59 +01:00
86 lines
2.3 KiB
Markdown
86 lines
2.3 KiB
Markdown
|
# Getting Started
|
|||
|
|
|||
|
Let’s create and run our first actix web application. We’ll 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!
|
|||
|
|
|||
|
Let’s 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
|
|||
|
and returns a `HttpResponse` instance or actor that uses `HttpContext` as an actor's context::
|
|||
|
|
|||
|
```rust,ignore
|
|||
|
extern crate actix_web;
|
|||
|
use actix_web::prelude::*;
|
|||
|
|
|||
|
fn index(req: HttpRequest) -> Result<HttpResponse> {
|
|||
|
Ok(httpcodes::HTTPOk.with_body("Hello world!"))
|
|||
|
}
|
|||
|
```
|
|||
|
|
|||
|
Next, create an `Application` instance and register the
|
|||
|
request handler with the application's `resource` on a particular *HTTP method* and *path*::
|
|||
|
|
|||
|
```rust,ignore
|
|||
|
let app = Application::default("/")
|
|||
|
.resource("/", |r| r.handler(Method::GET, index)
|
|||
|
.finish()
|
|||
|
```
|
|||
|
|
|||
|
After that, application instance can be used with `HttpServer` to listen for incoming
|
|||
|
connections:
|
|||
|
|
|||
|
```rust,ignore
|
|||
|
HttpServer::new(app).serve::<_, ()>("127.0.0.1:8088");
|
|||
|
```
|
|||
|
|
|||
|
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;
|
|||
|
use actix_web::prelude::*;
|
|||
|
|
|||
|
fn index(req: HttpRequest) -> Result<HttpResponse> {
|
|||
|
Ok(httpcodes::HTTPOk.with_body("Hello world!"))
|
|||
|
}
|
|||
|
|
|||
|
fn main() {
|
|||
|
let sys = actix::System::new("example");
|
|||
|
|
|||
|
HttpServer::new(
|
|||
|
Application::default("/")
|
|||
|
.resource("/", |r| r.handler(Method::GET, index)))
|
|||
|
.serve::<_, ()>("127.0.0.1:8088").unwrap();
|
|||
|
|
|||
|
println!("Started http server: 127.0.0.1:8088");
|
|||
|
// do not copy this line
|
|||
|
actix::Arbiter::system().send(actix::msgs::SystemExit(0));
|
|||
|
|
|||
|
let _ = sys.run();
|
|||
|
}
|
|||
|
```
|