2018-05-22 23:15:08 +02:00
|
|
|
|
---
|
|
|
|
|
title: Getting Started
|
|
|
|
|
menu: docs_basics
|
|
|
|
|
weight: 130
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Getting Started
|
|
|
|
|
|
2019-06-20 00:00:31 +02:00
|
|
|
|
Let’s write our first `actix-web` application!
|
2018-05-22 23:15:08 +02:00
|
|
|
|
|
|
|
|
|
## Hello, world!
|
|
|
|
|
|
|
|
|
|
Start by creating a new binary-based Cargo project and changing into the new directory:
|
|
|
|
|
|
|
|
|
|
```bash
|
2018-05-26 09:31:13 +02:00
|
|
|
|
cargo new hello-world
|
2018-05-22 23:15:08 +02:00
|
|
|
|
cd hello-world
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Now, add `actix-web` as dependencies of your project by ensuring your `Cargo.toml`
|
|
|
|
|
contains the following:
|
|
|
|
|
|
|
|
|
|
```ini
|
|
|
|
|
[dependencies]
|
|
|
|
|
actix-web = "{{< actix-version "actix-web" >}}"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
In order to implement a web server, we first need to create a request handler.
|
|
|
|
|
|
2019-06-20 00:00:31 +02:00
|
|
|
|
A request handler is a function that accepts zero or more parameters that can be
|
|
|
|
|
extracted from a request (ie, `impl FromRequest`) and returns a type that can be
|
|
|
|
|
converted into an `HttpResponse` (ie, `impl Responder`):
|
2018-05-22 23:15:08 +02:00
|
|
|
|
|
2018-05-23 23:25:51 +02:00
|
|
|
|
{{< include-example example="getting-started" section="setup" >}}
|
2018-05-22 23:15:08 +02:00
|
|
|
|
|
2019-06-20 00:00:31 +02:00
|
|
|
|
Next, create an `App` instance and register the request handler with the application's
|
|
|
|
|
`route` on a *path* and with a particular *HTTP method*. After that, the application
|
|
|
|
|
instance can be used with `HttpServer` to listen for incoming connections. The server
|
|
|
|
|
accepts a function that should return an application factory.
|
2018-05-22 23:15:08 +02:00
|
|
|
|
|
2018-05-23 23:25:51 +02:00
|
|
|
|
{{< include-example example="getting-started" section="main" >}}
|
2018-05-22 23:15:08 +02:00
|
|
|
|
|
|
|
|
|
That's it! Now, compile and run the program with `cargo run`.
|
|
|
|
|
Head over to ``http://localhost:8088/`` to see the results.
|
|
|
|
|
|
2019-08-05 17:29:01 +02:00
|
|
|
|
### Auto-reloading
|
|
|
|
|
|
|
|
|
|
If you want, you can have an automatically reloading server during development
|
|
|
|
|
that recompiles on demand. This isn't necessary, but it makes rapid prototyping
|
|
|
|
|
more convenient as you can see changes instantly upon saving.
|
|
|
|
|
To see how this can be accomplished, have a look at the [autoreload pattern][autoload].
|
2019-06-25 05:36:32 +02:00
|
|
|
|
|
|
|
|
|
[autoload]: ../autoreload/
|