https://github.com/theawiteb/actix-helloworld
Nice introduction for anyone who wants to learn the Actix framework
https://github.com/theawiteb/actix-helloworld
Last synced: about 1 year ago
JSON representation
Nice introduction for anyone who wants to learn the Actix framework
- Host: GitHub
- URL: https://github.com/theawiteb/actix-helloworld
- Owner: TheAwiteb
- License: mit
- Created: 2022-04-18T09:40:51.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:31:09.000Z (over 3 years ago)
- Last Synced: 2025-02-13T07:15:53.697Z (over 1 year ago)
- Language: Rust
- Size: 61.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# actix-helloworld
## What is actix-helloworld
actix-helloworld It is a simple project that shows the advantages of the [Actix] framework, it is a nice
introduction for who wants to learn [Actix]
[Actix]: https://actix.rs/
## Requirements
* [Cargo]
[Cargo]: https://doc.rust-lang.org/cargo/getting-started/installation.html
### Build
```bash
cargo build
```
### Run
```bash
cargo run
```
## Endpoints
```json
{
"status":true,
"endpoints":[
{
"endpoint":"/api",
"method":"GET",
"description":"Explanation of all endpoints",
"parameters":null,
"errors":null
},
{
"endpoint":"/api/hello-world",
"method":"GET",
"description":"Hello world endpoint",
"parameters":null,
"errors":null
},
{
"endpoint":"/api/hello",
"method":"GET",
"description":"Say hello to user",
"parameters":[
{
"name":"name",
"description":"Name of user",
"optional":true
}
],
"errors":[
{
"status":false,
"code":400,
"error":"LongUsername",
"message":"The username should be smaller than 30 character"
}
]
},
{
"endpoint":"/api/hello",
"method":"GET",
"description":"Say hello to user",
"parameters":[
{
"name":"name",
"description":"Name of user",
"optional":true
}
],
"errors":[
{
"status":false,
"code":400,
"error":"LongUsername",
"message":"The username should be smaller than 30 character"
}
]
}
]
}
```
## License
actix-helloworld license is [MIT], license file [`LICENSE`]
[MIT]: https://opensource.org/licenses/MIT
[`LICENSE`]: LICENSE