1
0
mirror of https://github.com/actix/actix-website synced 2024-11-24 16:52:59 +01:00
actix-website/content/docs/getting-started.md
2019-06-13 03:24:25 -04:00

1.5 KiB
Raw Blame History

title menu weight
Getting Started docs_basics 130

Getting Started

Lets write our first actix web application!

Hello, world!

Start by creating a new binary-based Cargo project and changing into the new directory:

cargo new hello-world
cd hello-world

Now, add actix-web as dependencies of your project by ensuring your Cargo.toml contains the following:

[dependencies]
actix-web = "{{< actix-version "actix-web" >}}"

In order to implement a web server, we first need to create a request handler.

A request handler is a function that accepts an HttpRequest instance as its only parameter and returns a type that can be converted into HttpResponse:

Filename: src/main.rs

{{< include-example example="getting-started" section="setup" >}}

Next, create an Application instance and register the request handler with the application's resource on a particular HTTP method and path and after that, the application instance can be used with HttpServer to listen for incoming connections. The server accepts a function that should return an HttpResponse.

{{< include-example example="getting-started" section="main" >}}

That's it! Now, compile and run the program with cargo run. Head over to http://localhost:8088/ to see the results.

If you want, you can have an automatic reloading server during development that recompiles on demand. To see how this can be accomplished have a look at the autoreload pattern.