1
0
mirror of https://github.com/actix/actix-website synced 2024-12-18 18:03:12 +01:00
actix-website/docs/getting-started.md

55 lines
2.5 KiB
Markdown
Raw Normal View History

2018-05-22 23:15:08 +02:00
---
title: Getting Started
---
import RenderCodeBlock from '@theme/CodeBlock';
import CodeBlock from "@site/src/components/code_block";
import vars from "@site/vars";
2020-09-12 17:21:54 +02:00
## Installing Rust
2018-05-22 23:15:08 +02:00
2022-02-26 05:41:49 +01: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.
2020-09-12 17:21:54 +02:00
<p>
Actix Web currently has a minimum supported Rust version (MSRV) of { vars.rustVersion }. Running <code>rustup update</code> will ensure you have the latest and greatest Rust version available. As such, this guide assumes you are running Rust { vars.rustVersion } or later.
</p>
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.
<!-- DEPENDENCY -->
<RenderCodeBlock className="language-toml">
{`[dependencies]
actix-web = "${vars.actixWebMajorVersion}"`}
</RenderCodeBlock>
2018-05-22 23:15:08 +02:00
2022-02-26 05:41:49 +01:00
Request handlers use async functions that accept zero or more parameters. These parameters can be 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
Replace the contents of `src/main.rs` with the following:
<CodeBlock example="getting-started" section="handlers" />
2018-05-22 23:15:08 +02:00
2022-02-26 05:41:49 +01: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 `manual_hello` (i.e. routes that do not use a routing macro).
2018-05-22 23:15:08 +02:00
2022-02-26 05:41:49 +01:00
Next, create an `App` instance and register the request handlers. Use `App::service` for the handlers using routing macros and `App::route` for manually routed handlers, declaring the path 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
Further append the following `main` function to `src/main.rs`:
<CodeBlock example="getting-started" section="main" />
2018-05-22 23:15:08 +02:00
2022-02-26 05:41:49 +01: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 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/