Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ellie-sleightholm/vercel-rust
This project is a Rust API deployed on Vercel. It is designed for users to build Rust code which can then be called using POST requests. This repository is an easy to use Rust-Vercel API that can be amended for your own requirements.
https://github.com/ellie-sleightholm/vercel-rust
api rust rust-lang rust-vercel vercel vercel-deployment vercel-rust vercel-rust-runtime
Last synced: 5 days ago
JSON representation
This project is a Rust API deployed on Vercel. It is designed for users to build Rust code which can then be called using POST requests. This repository is an easy to use Rust-Vercel API that can be amended for your own requirements.
- Host: GitHub
- URL: https://github.com/ellie-sleightholm/vercel-rust
- Owner: ellie-sleightholm
- Created: 2024-02-25T15:14:15.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-13T21:05:57.000Z (10 months ago)
- Last Synced: 2024-04-21T00:49:56.611Z (9 months ago)
- Topics: api, rust, rust-lang, rust-vercel, vercel, vercel-deployment, vercel-rust, vercel-rust-runtime
- Language: Rust
- Homepage: https://vercel-rust-two.vercel.app
- Size: 34.2 KB
- Stars: 15
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rust Vercel API
## Introduction
This project is a Rust API deployed on Vercel. It is designed for users to build Rust code which can then be called using POST requests. This repository is an easy to use Rust-Vercel API that can be amended for your own requirements.
## Example
There are 3 API calls in the repository and they are outlined below:
1) A basic indexing call:
```http
POST https://vercel-rust-two.vercel.app/api/user/[1]
Content-Type: application/json
{}
```
This returns the number received at the end of the url. In this case we have `1`.
```bash
[
1
]
```
2) A random planet generator.
```http
POST https://vercel-rust-two.vercel.app/api/simple
Content-Type: application/json
{}
```
This returns a randomly generated planet in our Solar System.
```bash
{
"message": "I choose the planet, Earth!"
}
```
3) A random planet generator with a specified input.
```http
POST https://vercel-rust-two.vercel.app/api/complex
Content-Type: application/json
{
"name": "Ellie"
}
```
This returns a randomly generated planet in our Solar System.
```bash
{
"message": "Ellie says: I choose the planet, Uranus!"
}
```
## Using this Rust API for Your Own Projects
This repository can be cloned and used for your own personal projects. To clone the repository:
```bash
git clone https://github.com/ellie-sleightholm/vercel-rust.git
```
Once cloned, you can use the contents of this repository in your own personal repository. It is important that you have your repository linked to Vercel ready for deployment. Then you're ready to go! Make changes and push to GitHub which will create your own personal URL. You can use this when making POST requests (see [here](request.http).)