1
0
mirror of https://github.com/actix/actix-website synced 2024-11-28 02:22:57 +01:00
actix-website/content/docs/getting-started.md

57 lines
2.2 KiB
Markdown
Raw Normal View History

2018-05-22 23:15:08 +02:00
---
title: Getting Started
menu: docs_basics
weight: 130
---
2020-09-12 17:21:54 +02:00
## Installing Rust
2018-05-22 23:15:08 +02:00
2020-09-12 17:21:54 +02:00
If you don't have Rust yet, we recommend you use `rustup` to manage your Rust installation. The
[official rust guide][rustguide] has a wonderful section on getting started.
Actix Web currently has a minimum supported Rust version (MSRV) of {{< rust-version "actix-web" >}}.
Running `rustup update` will ensure you have the latest and greatest Rust version available. As
such, this guide assumes you are running Rust {{< rust-version "actix-web" >}} or later.
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
cargo new hello-world
2018-05-22 23:15:08 +02:00
cd hello-world
```
2020-09-12 17:21:54 +02:00
Add `actix-web` as a dependency of your project by adding the following to your `Cargo.toml` file.
2020-09-12 17:21:54 +02:00
```toml
2018-05-22 23:15:08 +02:00
[dependencies]
actix-web = "{{< actix-version "actix-web" >}}"
```
2020-10-21 11:44:07 +02:00
Request handlers use async functions that accept zero or more parameters. These parameters can be
2020-09-12 17:21:54 +02:00
extracted from a request (see `FromRequest` trait) and returns a type that can be converted into an
`HttpResponse` (see `Responder` trait):
2018-05-22 23:15:08 +02:00
2020-09-12 17:21:54 +02:00
{{< include-example example="getting-started" section="handlers" >}}
2018-05-22 23:15:08 +02:00
2020-09-12 17:21:54 +02:00
Notice that some of these handlers have routing information attached directly using the built-in
macros. These allow you to specify the method and path that the handler should respond to. You will
see below how to register the other route that does not use a routing macro.
2018-05-22 23:15:08 +02:00
2020-09-12 17:21:54 +02:00
Next, create an `App` instance and register the request handlers. Use `App::service` for the
2020-11-05 14:50:03 +01:00
handlers using routing macros and `App::route` for manually routed handlers, declaring the path
2020-09-12 17:21:54 +02:00
and method. Finally, the app is started inside an `HttpServer` which will serve incoming requests
using your `App` as 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
2020-09-12 17:21:54 +02:00
That's it! Compile and run the program with `cargo run`. The `#[actix_web::main]` macro executes the
async main function within the actix runtime. Now you can go to `http://127.0.0.1:8080/` or any of
2020-09-12 17:21:54 +02:00
the other routes you defined to see the results.
2020-09-12 17:21:54 +02:00
<!-- LINKS -->
2020-09-12 17:21:54 +02:00
[rustguide]: https://doc.rust-lang.org/book/ch01-01-installation.html
2020-01-02 07:43:41 +01:00
[actix-web-codegen]: https://docs.rs/actix-web-codegen/